data
Confluent Cloud Lua API for KosmoKrator Agents
Agent-facing Lua documentation and function reference for the Confluent Cloud KosmoKrator integration.Lua Namespace
Agents call this integration through app.integrations.confluent.*.
Use lua_read_doc("integrations.confluent") inside KosmoKrator to discover the same reference at runtime.
Call Lua from the Headless CLI
Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic
Confluent Cloud workflow without starting an interactive agent session.
kosmo integrations:lua --eval 'dump(app.integrations.confluent.list_api_keys({}))' --json kosmo integrations:lua --eval 'print(docs.read("confluent"))' --json
kosmo integrations:lua --eval 'print(docs.read("confluent.list_api_keys"))' --json Workflow file
Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.
local confluent = app.integrations.confluent
local result = confluent.list_api_keys({})
dump(result) kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json integrations:lua exposes app.integrations.confluent, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.confluent.default.* or app.integrations.confluent.work.* when you configured named credential accounts.
MCP-only Lua
If the script only needs configured MCP servers and does not need Confluent Cloud, use the narrower mcp:lua command.
# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json Agent-Facing Lua Docs
This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.
Confluent Cloud - Lua API Reference
Namespace: app.integrations.confluent
This package exposes 486 generated tools from Confluent’s official Cloud API OpenAPI document at https://docs.confluent.io/cloud/current/openapi.yaml. It covers the published Confluent Cloud API groups, including IAM, organizations, Kafka, Schema Registry, Connect, Flink, networking, billing, catalog, stream sharing, provider integrations, Tableflow, artifacts, and related Cloud resources.
Authentication
Confluent Cloud API keys use HTTP Basic authentication with api_key and api_secret. OAuth, STS, external, partner, or resource-specific bearer credentials can be supplied as access_token. The legacy api_token field is still accepted as a bearer token for hosts that already configured it.
Common Operations
local environments = app.integrations.confluent.list_environments({ page_size = 10 })
local clusters = app.integrations.confluent.list_clusters({ environment = "env-abc123" })
local topics = app.integrations.confluent.list_topics({ cluster_id = "lkc-abc123" })
local topic = app.integrations.confluent.get_topic({
cluster_id = "lkc-abc123",
topic_name = "orders"
})
app.integrations.confluent.create_topic({
cluster_id = "lkc-abc123",
topic_name = "orders",
partitions_count = 6
})
Generated Tool Shape
Tool names follow the upstream operation name, normalized to snake_case with a confluent_ prefix in metadata and exposed without the prefix in Lua. Existing common names such as list_topics, get_topic, create_topic, list_clusters, get_cluster, and list_environments are preserved where they map to official endpoints.
Path parameters with a single resource id accept id for convenience. Specific generated parameter names such as cluster_id, topic_name, environment, id, name, and API-group-specific identifiers are also accepted when the upstream path needs them.
Request bodies can be passed as body = { ... }. For convenience, generated tools also collect loose arguments that are not path, query, or header parameters into the JSON body.
Coverage Notes
Confluent documents different API groups with different versions rather than a single API version. This integration intentionally uses the combined official Cloud API source and does not expose undocumented endpoints such as the old hand-written /users/me health check.
Multi-Account Usage
app.integrations.confluent.list_environments({})
app.integrations.confluent.production.list_topics({ cluster_id = "lkc-prod" })
app.integrations.confluent.staging.list_topics({ cluster_id = "lkc-staging" })
All functions are identical across accounts; only the resolved credentials differ.
Raw agent markdown
# Confluent Cloud - Lua API Reference
Namespace: `app.integrations.confluent`
This package exposes 486 generated tools from Confluent's official Cloud API OpenAPI document at `https://docs.confluent.io/cloud/current/openapi.yaml`. It covers the published Confluent Cloud API groups, including IAM, organizations, Kafka, Schema Registry, Connect, Flink, networking, billing, catalog, stream sharing, provider integrations, Tableflow, artifacts, and related Cloud resources.
## Authentication
Confluent Cloud API keys use HTTP Basic authentication with `api_key` and `api_secret`. OAuth, STS, external, partner, or resource-specific bearer credentials can be supplied as `access_token`. The legacy `api_token` field is still accepted as a bearer token for hosts that already configured it.
## Common Operations
```lua
local environments = app.integrations.confluent.list_environments({ page_size = 10 })
local clusters = app.integrations.confluent.list_clusters({ environment = "env-abc123" })
local topics = app.integrations.confluent.list_topics({ cluster_id = "lkc-abc123" })
local topic = app.integrations.confluent.get_topic({
cluster_id = "lkc-abc123",
topic_name = "orders"
})
app.integrations.confluent.create_topic({
cluster_id = "lkc-abc123",
topic_name = "orders",
partitions_count = 6
})
```
## Generated Tool Shape
Tool names follow the upstream operation name, normalized to snake_case with a `confluent_` prefix in metadata and exposed without the prefix in Lua. Existing common names such as `list_topics`, `get_topic`, `create_topic`, `list_clusters`, `get_cluster`, and `list_environments` are preserved where they map to official endpoints.
Path parameters with a single resource id accept `id` for convenience. Specific generated parameter names such as `cluster_id`, `topic_name`, `environment`, `id`, `name`, and API-group-specific identifiers are also accepted when the upstream path needs them.
Request bodies can be passed as `body = { ... }`. For convenience, generated tools also collect loose arguments that are not path, query, or header parameters into the JSON body.
## Coverage Notes
Confluent documents different API groups with different versions rather than a single API version. This integration intentionally uses the combined official Cloud API source and does not expose undocumented endpoints such as the old hand-written `/users/me` health check.
## Multi-Account Usage
```lua
app.integrations.confluent.list_environments({})
app.integrations.confluent.production.list_topics({ cluster_id = "lkc-prod" })
app.integrations.confluent.staging.list_topics({ cluster_id = "lkc-staging" })
```
All functions are identical across accounts; only the resolved credentials differ. local result = app.integrations.confluent.list_api_keys({})
print(result) Functions
list_api_keys Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all API keys. This can show all keys for a single owner across resources - Kafka clusters, or all keys for a single resource across owners. If no owner or resource filters are specified, returns all API Keys in the organization. You will only see the keys that are accessible to the account making the API request.
- Lua path
app.integrations.confluent.list_api_keys- Full name
confluent.confluent_list_iam_v2_api_keys
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_api_key Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create an API key.
- Lua path
app.integrations.confluent.create_api_key- Full name
confluent.confluent_create_iam_v2_api_key
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_api_key Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read an API key.
- Lua path
app.integrations.confluent.read_api_key- Full name
confluent.confluent_get_iam_v2_api_key
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_api_key Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update an API key.
- Lua path
app.integrations.confluent.update_api_key- Full name
confluent.confluent_update_iam_v2_api_key
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_api_key Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete an API key.
- Lua path
app.integrations.confluent.delete_api_key- Full name
confluent.confluent_delete_iam_v2_api_key
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_environments Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all environments.
- Lua path
app.integrations.confluent.list_environments- Full name
confluent.confluent_list_environments
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_environment Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create an environment.
- Lua path
app.integrations.confluent.create_environment- Full name
confluent.confluent_create_org_v2_environment
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_environment Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read an environment.
- Lua path
app.integrations.confluent.read_environment- Full name
confluent.confluent_get_org_v2_environment
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_environment Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update an environment.
- Lua path
app.integrations.confluent.update_environment- Full name
confluent.confluent_update_org_v2_environment
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_environment Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete an environment. If successful, this request will also recursively delete all of the environment's associated resources, including all Kafka clusters, connectors, etc.
- Lua path
app.integrations.confluent.delete_environment- Full name
confluent.confluent_delete_org_v2_environment
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_organizations Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all organizations.
- Lua path
app.integrations.confluent.list_organizations- Full name
confluent.confluent_list_org_v2_organizations
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_organization Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read an organization.
- Lua path
app.integrations.confluent.read_organization- Full name
confluent.confluent_get_org_v2_organization
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_organization Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update an organization.
- Lua path
app.integrations.confluent.update_organization- Full name
confluent.confluent_update_org_v2_organization
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_users Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all users.
- Lua path
app.integrations.confluent.list_users- Full name
confluent.confluent_list_iam_v2_users
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_user Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read a user.
- Lua path
app.integrations.confluent.read_user- Full name
confluent.confluent_get_iam_v2_user
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_user Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update a user.
- Lua path
app.integrations.confluent.update_user- Full name
confluent.confluent_update_iam_v2_user
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_user Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete a user. If successful, this request will also recursively delete all of the user's associated resources, including its cloud and cluster API keys.
- Lua path
app.integrations.confluent.delete_user- Full name
confluent.confluent_delete_iam_v2_user
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_auth_type_user Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Update the auth type of a user
- Lua path
app.integrations.confluent.update_auth_type_user- Full name
confluent.confluent_update_auth_type_iam_v2_user
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_service_accounts Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all service accounts.
- Lua path
app.integrations.confluent.list_service_accounts- Full name
confluent.confluent_list_iam_v2_service_accounts
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_service_account Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create a service account.
- Lua path
app.integrations.confluent.create_service_account- Full name
confluent.confluent_create_iam_v2_service_account
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_service_account Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read a service account.
- Lua path
app.integrations.confluent.read_service_account- Full name
confluent.confluent_get_iam_v2_service_account
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_service_account Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update a service account.
- Lua path
app.integrations.confluent.update_service_account- Full name
confluent.confluent_update_iam_v2_service_account
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_service_account Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete a service account. If successful, this request will also recursively delete all of the service account's associated resources, including its cloud and cluster API keys.
- Lua path
app.integrations.confluent.delete_service_account- Full name
confluent.confluent_delete_iam_v2_service_account
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_invitations Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all invitations.
- Lua path
app.integrations.confluent.list_invitations- Full name
confluent.confluent_list_iam_v2_invitations
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_invitation Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create an invitation. The newly invited user will not have any permissions. Give the user permission by assigning them to one or more roles by creating role bindingshttps://docs.confluent.io/cloud/current/api.htmltag/Role-Bindings-iamv2 for the created user.
- Lua path
app.integrations.confluent.create_invitation- Full name
confluent.confluent_create_iam_v2_invitation
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_invitation Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read an invitation.
- Lua path
app.integrations.confluent.read_invitation- Full name
confluent.confluent_get_iam_v2_invitation
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_invitation Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete an invitation. Delete will deactivate the user if the user didn't accept the invitation yet.
- Lua path
app.integrations.confluent.delete_invitation- Full name
confluent.confluent_delete_iam_v2_invitation
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_ip_groups Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all IP groups.
- Lua path
app.integrations.confluent.list_ip_groups- Full name
confluent.confluent_list_iam_v2_ip_groups
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_ip_group Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create an IP group.
- Lua path
app.integrations.confluent.create_ip_group- Full name
confluent.confluent_create_iam_v2_ip_group
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_ip_group Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read an IP group.
- Lua path
app.integrations.confluent.read_ip_group- Full name
confluent.confluent_get_iam_v2_ip_group
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_ip_group Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update an IP group.
- Lua path
app.integrations.confluent.update_ip_group- Full name
confluent.confluent_update_iam_v2_ip_group
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_ip_group Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete an IP group.
- Lua path
app.integrations.confluent.delete_ip_group- Full name
confluent.confluent_delete_iam_v2_ip_group
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_ip_filters Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all IP filters.
- Lua path
app.integrations.confluent.list_ip_filters- Full name
confluent.confluent_list_iam_v2_ip_filters
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_ip_filter Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create an IP filter.
- Lua path
app.integrations.confluent.create_ip_filter- Full name
confluent.confluent_create_iam_v2_ip_filter
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_ip_filter Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read an IP filter.
- Lua path
app.integrations.confluent.read_ip_filter- Full name
confluent.confluent_get_iam_v2_ip_filter
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_ip_filter Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update an IP filter.
- Lua path
app.integrations.confluent.update_ip_filter- Full name
confluent.confluent_update_iam_v2_ip_filter
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_ip_filter Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete an IP filter.
- Lua path
app.integrations.confluent.delete_ip_filter- Full name
confluent.confluent_delete_iam_v2_ip_filter
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_ip_filter_summary Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read an IP filter summary.
- Lua path
app.integrations.confluent.read_ip_filter_summary- Full name
confluent.confluent_get_iam_v2_ip_filter_summary
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_role_bindings Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all role bindings.
- Lua path
app.integrations.confluent.list_role_bindings- Full name
confluent.confluent_list_iam_v2_role_bindings
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_role_binding Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create a role binding.
- Lua path
app.integrations.confluent.create_role_binding- Full name
confluent.confluent_create_iam_v2_role_binding
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_role_binding Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read a role binding.
- Lua path
app.integrations.confluent.read_role_binding- Full name
confluent.confluent_get_iam_v2_role_binding
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_role_binding Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete a role binding.
- Lua path
app.integrations.confluent.delete_role_binding- Full name
confluent.confluent_delete_iam_v2_role_binding
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_subscriptions Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all subscriptions.
- Lua path
app.integrations.confluent.list_subscriptions- Full name
confluent.confluent_list_notifications_v1_subscriptions
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_subscription Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create a subscription.
- Lua path
app.integrations.confluent.create_subscription- Full name
confluent.confluent_create_notifications_v1_subscription
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_subscription Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read a subscription.
- Lua path
app.integrations.confluent.read_subscription- Full name
confluent.confluent_get_notifications_v1_subscription
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_subscription Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update a subscription.
- Lua path
app.integrations.confluent.update_subscription- Full name
confluent.confluent_update_notifications_v1_subscription
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_subscription Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete a subscription.
- Lua path
app.integrations.confluent.delete_subscription- Full name
confluent.confluent_delete_notifications_v1_subscription
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_integrations Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all integrations.
- Lua path
app.integrations.confluent.list_integrations- Full name
confluent.confluent_list_notifications_v1_integrations
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_integration Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create an integration.
- Lua path
app.integrations.confluent.create_integration- Full name
confluent.confluent_create_notifications_v1_integration
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_integration Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read an integration.
- Lua path
app.integrations.confluent.read_integration- Full name
confluent.confluent_get_notifications_v1_integration
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_integration Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update an integration.
- Lua path
app.integrations.confluent.update_integration- Full name
confluent.confluent_update_notifications_v1_integration
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_integration Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete an integration.
- Lua path
app.integrations.confluent.delete_integration- Full name
confluent.confluent_delete_notifications_v1_integration
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
test_webhook_slack_or_microsoft_teams_integration Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Sends a test notification to validate the integration. This is supported only for Webhook, Slack and MsTeams targets
- Lua path
app.integrations.confluent.test_webhook_slack_or_microsoft_teams_integration- Full name
confluent.confluent_test_notifications_v1_integration
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_notification_type Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read a notification type.
- Lua path
app.integrations.confluent.read_notification_type- Full name
confluent.confluent_get_notifications_v1_notification_type
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
retrieve_list_all_notification_types_resource_type Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to listbyresourcetype a notification type.
- Lua path
app.integrations.confluent.retrieve_list_all_notification_types_resource_type- Full name
confluent.confluent_list_notifications_v1_notification_types
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_resource_preference Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create a resource preference.
- Lua path
app.integrations.confluent.create_resource_preference- Full name
confluent.confluent_create_notifications_v1_resource_preference
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_resource_preference Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read a resource preference.
- Lua path
app.integrations.confluent.read_resource_preference- Full name
confluent.confluent_get_notifications_v1_resource_preference
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_resource_preference Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update a resource preference.
- Lua path
app.integrations.confluent.update_resource_preference- Full name
confluent.confluent_update_notifications_v1_resource_preference
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_resource_preference Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete a resource preference.
- Lua path
app.integrations.confluent.delete_resource_preference- Full name
confluent.confluent_delete_notifications_v1_resource_preference
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
lookup_resource_preference_by_filter_returns_one Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to readbyfilter a resource preference.
- Lua path
app.integrations.confluent.lookup_resource_preference_by_filter_returns_one- Full name
confluent.confluent_get_notifications_v1_resource_preference_by_filter
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_resource_subscription Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create a resource subscription.
- Lua path
app.integrations.confluent.create_resource_subscription- Full name
confluent.confluent_create_notifications_v1_resource_subscription
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_resource_subscription Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read a resource subscription.
- Lua path
app.integrations.confluent.read_resource_subscription- Full name
confluent.confluent_get_notifications_v1_resource_subscription
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_resource_subscription Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update a resource subscription.
- Lua path
app.integrations.confluent.update_resource_subscription- Full name
confluent.confluent_update_notifications_v1_resource_subscription
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_resource_subscription Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete a resource subscription.
- Lua path
app.integrations.confluent.delete_resource_subscription- Full name
confluent.confluent_delete_notifications_v1_resource_subscription
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
lookup_list_resource_subscription_by_filter Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to listbyfilter a resource subscription.
- Lua path
app.integrations.confluent.lookup_list_resource_subscription_by_filter- Full name
confluent.confluent_list_notifications_v1_resource_subscriptions_by_filter
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_clusters Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all clusters.
- Lua path
app.integrations.confluent.list_clusters- Full name
confluent.confluent_list_clusters
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_cluster Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create a cluster.
- Lua path
app.integrations.confluent.create_cluster- Full name
confluent.confluent_create_cmk_v2_cluster
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_cluster Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read a cluster.
- Lua path
app.integrations.confluent.read_cluster- Full name
confluent.confluent_get_cmk_v2_cluster
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_cluster Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update a cluster.
- Lua path
app.integrations.confluent.update_cluster- Full name
confluent.confluent_update_cmk_v2_cluster
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_cluster Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete a cluster.
- Lua path
app.integrations.confluent.delete_cluster- Full name
confluent.confluent_delete_cmk_v2_cluster
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_clusters Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all clusters.
- Lua path
app.integrations.confluent.list_clusters- Full name
confluent.confluent_list_ksqldbcm_v2_clusters
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_cluster Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create a cluster.
- Lua path
app.integrations.confluent.create_cluster- Full name
confluent.confluent_create_ksqldbcm_v2_cluster
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_cluster Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read a cluster.
- Lua path
app.integrations.confluent.read_cluster- Full name
confluent.confluent_get_ksqldbcm_v2_cluster
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_cluster Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete a cluster.
- Lua path
app.integrations.confluent.delete_cluster- Full name
confluent.confluent_delete_ksqldbcm_v2_cluster
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_connectors Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a list of "names" of the active connectors. You can then make a read requestoperation/readConnectv1Connector for a specific connector by name.
- Lua path
app.integrations.confluent.list_connectors- Full name
confluent.confluent_list_connectv1_connectors
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_connector Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Create a new connector. Returns the new connector information if successful.
- Lua path
app.integrations.confluent.create_connector- Full name
confluent.confluent_create_connectv1_connector
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_connectors_with_expansions Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve an object with the queried expansions of all connectors. Without expand query parameter, this list connector's endpoint will return a list of only the connector namesoperation/listConnectv1Connectors.
- Lua path
app.integrations.confluent.list_connectors_with_expansions- Full name
confluent.confluent_list_connectv1_connectors_with_expansions
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_connector_configuration Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Get the configuration for the connector.
- Lua path
app.integrations.confluent.read_connector_configuration- Full name
confluent.confluent_get_connectv1_connector_config
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_or_update_connector_configuration Write
Create a new connector using the given configuration, or update the configuration for an existing connector. Returns information about the connector after the change has been made.
- Lua path
app.integrations.confluent.create_or_update_connector_configuration- Full name
confluent.confluent_create_or_update_connectv1_connector_config
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_connector Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Get information about the connector.
- Lua path
app.integrations.confluent.read_connector- Full name
confluent.confluent_read_connectv1_connector
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_connector Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Delete a connector. Halts all tasks and deletes the connector configuration.
- Lua path
app.integrations.confluent.delete_connector- Full name
confluent.confluent_delete_connectv1_connector
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
pause_connector Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Pause the connector and its tasks. Stops message processing until the connector is resumed. This call is asynchronous and the tasks will not transition to PAUSED state at the same time.
- Lua path
app.integrations.confluent.pause_connector- Full name
confluent.confluent_pause_connectv1_connector
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
resume_connector Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Resume a paused connector or do nothing if the connector is not paused. This call is asynchronous and the tasks will not transition to RUNNING state at the same time.
- Lua path
app.integrations.confluent.resume_connector- Full name
confluent.confluent_resume_connectv1_connector
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
restart_connector Write
!Previewhttps://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afbasection/Versioning/API-Lifecycle-Policy Restart the connector and its tasks. Stops message processing until the connector and tasks are restart. This call is asynchronous and the connector will not transition to another state at the same time.
- Lua path
app.integrations.confluent.restart_connector- Full name
confluent.confluent_restart_connectv1_connector
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_connector_status Read
Get current status of the connector. This includes whether it is running, failed, or paused. Also includes which worker it is assigned to, error information if it has failed, and the state of all its tasks.
- Lua path
app.integrations.confluent.read_connector_status- Full name
confluent.confluent_read_connectv1_connector_status
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_connector_tasks Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Get a list of tasks currently running for the connector.
- Lua path
app.integrations.confluent.list_connector_tasks- Full name
confluent.confluent_list_connectv1_connector_tasks
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_managed_connector_plugins Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Return a list of Managed Connector plugins installed in the Kafka Connect cluster.
- Lua path
app.integrations.confluent.list_managed_connector_plugins- Full name
confluent.confluent_list_connectv1_connector_plugins
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
validate_managed_connector_plugin Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Validate the provided configuration values against the configuration definition. This API performs per config validation and returns suggested values and validation error messages.
- Lua path
app.integrations.confluent.validate_managed_connector_plugin- Full name
confluent.confluent_validate_connectv1_connector_plugin
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
translate_self_managed_connector_plugin_configurations_fully_managed_connector_plugin_configurations Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Translate the provided Self Managed configuration values. This API performs configuration translation and returns the translated fully managed configuration along with any errors or warnings. Query Parameter masksensitive=true redacts sensitive config values in response.
- Lua path
app.integrations.confluent.translate_self_managed_connector_plugin_configurations_fully_managed_connector_plugin_configurations- Full name
confluent.confluent_translate_connectv1_connector_plugin
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_connector_offsets Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Get the current offsets for the connector. The offsets provide information on the point in the source system, from which the connector is pulling in data. The offsets of a connector are continuously observed periodically and are queryable via this API.
- Lua path
app.integrations.confluent.get_connector_offsets- Full name
confluent.confluent_get_connectv1_connector_offsets
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
request_alter_connector_offsets Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Request to alter the offsets of a connector. This supports the ability to PATCH/DELETE the offsets of a connector. Note, you will see momentary downtime as this will internally stop the connector, while the offsets are being altered. You can only make one alter offsets request at a time for a connector.
- Lua path
app.integrations.confluent.request_alter_connector_offsets- Full name
confluent.confluent_alter_connectv1_connector_offsets_request
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_status_alter_offset_request Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Get the status of the previous alter offset request.
- Lua path
app.integrations.confluent.get_status_alter_offset_request- Full name
confluent.confluent_get_connectv1_connector_offsets_request_status
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_custom_connector_plugins Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all custom connector plugins. If no cloud filter is specified, returns custom connector plugins from all clouds.
- Lua path
app.integrations.confluent.list_custom_connector_plugins- Full name
confluent.confluent_list_connect_v1_custom_connector_plugins
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_custom_connector_plugin Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create a custom connector plugin.
- Lua path
app.integrations.confluent.create_custom_connector_plugin- Full name
confluent.confluent_create_connect_v1_custom_connector_plugin
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_custom_connector_plugin Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read a custom connector plugin.
- Lua path
app.integrations.confluent.read_custom_connector_plugin- Full name
confluent.confluent_get_connect_v1_custom_connector_plugin
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_custom_connector_plugin Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update a custom connector plugin.
- Lua path
app.integrations.confluent.update_custom_connector_plugin- Full name
confluent.confluent_update_connect_v1_custom_connector_plugin
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_custom_connector_plugin Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete a custom connector plugin.
- Lua path
app.integrations.confluent.delete_custom_connector_plugin- Full name
confluent.confluent_delete_connect_v1_custom_connector_plugin
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
request_presigned_upload_url_new_custom_connector_plugin Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Request a presigned upload URL to upload a Custom Connector Plugin archive.
- Lua path
app.integrations.confluent.request_presigned_upload_url_new_custom_connector_plugin- Full name
confluent.confluent_presigned_upload_url_connect_v1_presigned_url
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_custom_connector_runtimes Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all custom connector runtimes.
- Lua path
app.integrations.confluent.list_custom_connector_runtimes- Full name
confluent.confluent_list_connect_v1_custom_connector_runtimes
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_cluster Read
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Return the Kafka cluster with the specified clusterid.
- Lua path
app.integrations.confluent.get_cluster- Full name
confluent.confluent_get_cluster
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
batch_create_acls Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Create ACLs.
- Lua path
app.integrations.confluent.batch_create_acls- Full name
confluent.confluent_batch_create_kafka_acls
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_acls Read
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy - When calling /acls without the principal parameter, service accounts are returned in numeric ID format e.g., User:12345. - To retrieve service accounts in the sa-xxx format, use /acls?principal=UserV2:. - The principal parameter supports both legacy User: format and new UserV2: format for service accounts. Return a list of ACLs that match the search criteria.
- Lua path
app.integrations.confluent.list_acls- Full name
confluent.confluent_get_kafka_acls
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_acl Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Create an ACL.
- Lua path
app.integrations.confluent.create_acl- Full name
confluent.confluent_create_kafka_acls
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_acls Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Delete the ACLs that match the search criteria.
- Lua path
app.integrations.confluent.delete_acls- Full name
confluent.confluent_delete_kafka_acls
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_dynamic_broker_configs Read
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Return a list of dynamic cluster-wide broker configuration parameters for the specified Kafka cluster. Returns an empty list if there are no dynamic cluster-wide broker configuration parameters.
- Lua path
app.integrations.confluent.list_dynamic_broker_configs- Full name
confluent.confluent_list_kafka_cluster_configs
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
batch_alter_dynamic_broker_configs Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Update or delete a set of dynamic cluster-wide broker configuration parameters.
- Lua path
app.integrations.confluent.batch_alter_dynamic_broker_configs- Full name
confluent.confluent_update_kafka_cluster_configs
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_dynamic_broker_config Read
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Return the dynamic cluster-wide broker configuration parameter specified by name.
- Lua path
app.integrations.confluent.get_dynamic_broker_config- Full name
confluent.confluent_get_kafka_cluster_config
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_dynamic_broker_config Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Update the dynamic cluster-wide broker configuration parameter specified by name.
- Lua path
app.integrations.confluent.update_dynamic_broker_config- Full name
confluent.confluent_update_kafka_cluster_config
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
reset_dynamic_broker_config Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Reset the configuration parameter specified by name to its default value by deleting a dynamic cluster-wide configuration.
- Lua path
app.integrations.confluent.reset_dynamic_broker_config- Full name
confluent.confluent_delete_kafka_cluster_config
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_consumer_groups Read
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Return the list of consumer groups that belong to the specified Kafka cluster.
- Lua path
app.integrations.confluent.list_consumer_groups- Full name
confluent.confluent_list_kafka_consumer_groups
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_consumer_group Read
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Return the consumer group specified by the consumergroupid.
- Lua path
app.integrations.confluent.get_consumer_group- Full name
confluent.confluent_get_kafka_consumer_group
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_consumers Read
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Return a list of consumers that belong to the specified consumer group.
- Lua path
app.integrations.confluent.list_consumers- Full name
confluent.confluent_list_kafka_consumers
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_consumer_group_lag_summary Read
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy !Available in dedicated clusters onlyhttps://img.shields.io/badge/-Available%20in%20dedicated%20clusters%20only-%23bc8540https://docs.confluent.io/cloud/current/clusters/cluster-types.htmldedicated-cluster Return the maximum and total lag of the consumers belonging to the specified consumer group.
- Lua path
app.integrations.confluent.get_consumer_group_lag_summary- Full name
confluent.confluent_get_kafka_consumer_group_lag_summary
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_consumer_lags Read
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy !Available in dedicated clusters onlyhttps://img.shields.io/badge/-Available%20in%20dedicated%20clusters%20only-%23bc8540https://docs.confluent.io/cloud/current/clusters/cluster-types.htmldedicated-cluster Return a list of consumer lags of the consumers belonging to the specified consumer group.
- Lua path
app.integrations.confluent.list_consumer_lags- Full name
confluent.confluent_list_kafka_consumer_lags
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_consumer_lag Read
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy !Available in dedicated clusters onlyhttps://img.shields.io/badge/-Available%20in%20dedicated%20clusters%20only-%23bc8540https://docs.confluent.io/cloud/current/clusters/cluster-types.htmldedicated-cluster Return the consumer lag on a partition with the given partitionid.
- Lua path
app.integrations.confluent.get_consumer_lag- Full name
confluent.confluent_get_kafka_consumer_lag
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_consumer Read
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Return the consumer specified by the consumerid.
- Lua path
app.integrations.confluent.get_consumer- Full name
confluent.confluent_get_kafka_consumer
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_topics Read
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Return the list of topics that belong to the specified Kafka cluster.
- Lua path
app.integrations.confluent.list_topics- Full name
confluent.confluent_list_topics
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_topic Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Create a topic. Also supports a dry-run mode that only validates whether the topic creation would succeed if the validateonly request property is explicitly specified and set to true. Note that when dry-run mode is being used the response status would be 200 OK instead of 201 Created.
- Lua path
app.integrations.confluent.create_topic- Full name
confluent.confluent_create_topic
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_topic Read
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Return the topic with the given topicname.
- Lua path
app.integrations.confluent.get_topic- Full name
confluent.confluent_get_topic
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_partition_count Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Increase the number of partitions for a topic. To update other topic configurations, see https://docs.confluent.io/cloud/current/api.htmltag/Configs-v3/operation/updateKafkaTopicConfig.
- Lua path
app.integrations.confluent.update_partition_count- Full name
confluent.confluent_update_partition_count_kafka_topic
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_topic Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Delete the topic with the given topicname.
- Lua path
app.integrations.confluent.delete_topic- Full name
confluent.confluent_delete_kafka_topic
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_topic_configs Read
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Return the list of configuration parameters that belong to the specified topic.
- Lua path
app.integrations.confluent.list_topic_configs- Full name
confluent.confluent_list_kafka_topic_configs
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
batch_alter_topic_configs Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Update or delete a set of topic configuration parameters. Also supports a dry-run mode that only validates whether the operation would succeed if the validateonly request property is explicitly specified and set to true.
- Lua path
app.integrations.confluent.batch_alter_topic_configs- Full name
confluent.confluent_update_kafka_topic_config_batch
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_topic_config Read
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Return the configuration parameter with the given name.
- Lua path
app.integrations.confluent.get_topic_config- Full name
confluent.confluent_get_kafka_topic_config
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_topic_config Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Update the configuration parameter with given name. To update the number of partitions, see https://docs.confluent.io/cloud/current/api.htmltag/Topic-v3/operation/updatePartitionCountKafkaTopic.
- Lua path
app.integrations.confluent.update_topic_config- Full name
confluent.confluent_update_kafka_topic_config
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
reset_topic_config Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Reset the configuration parameter with given name to its default value.
- Lua path
app.integrations.confluent.reset_topic_config- Full name
confluent.confluent_delete_kafka_topic_config
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_partitions Read
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Return the list of partitions that belong to the specified topic.
- Lua path
app.integrations.confluent.list_partitions- Full name
confluent.confluent_list_kafka_partitions
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_partition Read
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Return the partition with the given partitionid.
- Lua path
app.integrations.confluent.get_partition- Full name
confluent.confluent_get_kafka_partition
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_all_topic_configs Read
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Return the list of configuration parameters for all topics hosted by the specified cluster.
- Lua path
app.integrations.confluent.list_all_topic_configs- Full name
confluent.confluent_list_kafka_all_topic_configs
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
produce_records Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Produce records to the given topic, returning delivery reports for each record produced. This API can be used in streaming mode by setting "Transfer-Encoding: chunked" header. For as long as the connection is kept open, the server will keep accepting records. Records are streamed to and from the server as Concatenated JSON. For each record sent to the server, the server will asynchronously send back a delivery report, in the same order, each with its own errorcode. An errorcode of 200 indicates success. The HTTP status code will be HTTP 200 OK as long as the connection is successfully established. To identify records that have encountered an error, check the errorcode of each delivery report. Note that the clusterid is validated only when running in Confluent Cloud. This API currently does not support Schema Registry integration. Sending schemas is not supported. Only BINARY, JSON, and STRING formats are supported.
- Lua path
app.integrations.confluent.produce_records- Full name
confluent.confluent_produce_record
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_all_cluster_links_dest_cluster Read
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy linkid in ListLinksResponseData is deprecated and may be removed in a future release. Use the new clusterlinkid instead.
- Lua path
app.integrations.confluent.list_all_cluster_links_dest_cluster- Full name
confluent.confluent_list_kafka_links
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_cluster_link Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Cluster link creation requires source cluster security configurations in the configs JSON section of the data request payload.
- Lua path
app.integrations.confluent.create_cluster_link- Full name
confluent.confluent_create_kafka_link
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
describe_cluster_link Read
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy linkid in ListLinksResponseData is deprecated and may be removed in a future release. Use the new clusterlinkid instead.
- Lua path
app.integrations.confluent.describe_cluster_link- Full name
confluent.confluent_get_kafka_link
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_cluster_link Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy
- Lua path
app.integrations.confluent.delete_cluster_link- Full name
confluent.confluent_delete_kafka_link
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_new_topic_default_configs Read
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy List the default configuration parameters used if the topic were to be newly created.
- Lua path
app.integrations.confluent.list_new_topic_default_configs- Full name
confluent.confluent_list_kafka_default_topic_configs
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_all_configs_cluster_link Read
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy
- Lua path
app.integrations.confluent.list_all_configs_cluster_link- Full name
confluent.confluent_list_kafka_link_configs
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
describe_config_under_cluster_link Read
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy
- Lua path
app.integrations.confluent.describe_config_under_cluster_link- Full name
confluent.confluent_get_kafka_link_configs
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
alter_config_under_cluster_link Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy
- Lua path
app.integrations.confluent.alter_config_under_cluster_link- Full name
confluent.confluent_update_kafka_link_config
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
reset_given_config_default_value Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy
- Lua path
app.integrations.confluent.reset_given_config_default_value- Full name
confluent.confluent_delete_kafka_link_config
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
batch_alter_cluster_link_configs Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Batch Alter Cluster Link Configs
- Lua path
app.integrations.confluent.batch_alter_cluster_link_configs- Full name
confluent.confluent_update_kafka_link_config_batch
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_mirror_topic Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Create a topic in the destination cluster mirroring a topic in the source cluster
- Lua path
app.integrations.confluent.create_mirror_topic- Full name
confluent.confluent_create_kafka_mirror_topic
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_mirror_topics Read
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy List all mirror topics under the link
- Lua path
app.integrations.confluent.list_mirror_topics- Full name
confluent.confluent_list_kafka_mirror_topics_under_link
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_mirror_topics Read
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy List all mirror topics in the cluster
- Lua path
app.integrations.confluent.list_mirror_topics- Full name
confluent.confluent_list_kafka_mirror_topics
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
describe_mirror_topic Read
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy
- Lua path
app.integrations.confluent.describe_mirror_topic- Full name
confluent.confluent_read_kafka_mirror_topic
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
promote_mirror_topics Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy
- Lua path
app.integrations.confluent.promote_mirror_topics- Full name
confluent.confluent_update_kafka_mirror_topics_promote
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
failover_mirror_topics Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy
- Lua path
app.integrations.confluent.failover_mirror_topics- Full name
confluent.confluent_update_kafka_mirror_topics_failover
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
pause_mirror_topics Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy
- Lua path
app.integrations.confluent.pause_mirror_topics- Full name
confluent.confluent_update_kafka_mirror_topics_pause
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
resume_mirror_topics Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy
- Lua path
app.integrations.confluent.resume_mirror_topics- Full name
confluent.confluent_update_kafka_mirror_topics_resume
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
reverse_local_mirror_topic_and_start_remote_mirror_topic Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy
- Lua path
app.integrations.confluent.reverse_local_mirror_topic_and_start_remote_mirror_topic- Full name
confluent.confluent_update_kafka_mirror_topics_reverse_and_start_mirror
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
reverse_local_mirror_topic_and_pause_remote_mirror_topic Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy
- Lua path
app.integrations.confluent.reverse_local_mirror_topic_and_pause_remote_mirror_topic- Full name
confluent.confluent_update_kafka_mirror_topics_reverse_and_pause_mirror
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
truncates_local_topic_remote_stopped_mirror_log_end_offsets_and_restores_mirroring_local_topic_mirror_from_remote_topic Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy
- Lua path
app.integrations.confluent.truncates_local_topic_remote_stopped_mirror_log_end_offsets_and_restores_mirroring_local_topic_mirror_from_remote_topic- Full name
confluent.confluent_update_kafka_mirror_topics_truncate_and_restore_mirror
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_all_configs_group Read
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy List all configurations for the specified group. This API supports consumer groups, share groups, and streams groups.
- Lua path
app.integrations.confluent.list_all_configs_group- Full name
confluent.confluent_list_kafka_group_configs
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_group_config Read
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Get the configuration with the specified name for the specified group. This API supports consumer groups, share groups, and streams groups.
- Lua path
app.integrations.confluent.get_group_config- Full name
confluent.confluent_get_kafka_group_config
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_group_config Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Update the configuration with the specified name for the specified group. This API supports consumer groups, share groups, and streams groups.
- Lua path
app.integrations.confluent.update_group_config- Full name
confluent.confluent_update_kafka_group_config
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_group_config Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Delete the dynamic configuration override with the specified name for the specified group. After deletion, the default group configuration will be applied. This API supports consumer groups, share groups, and streams groups.
- Lua path
app.integrations.confluent.delete_group_config- Full name
confluent.confluent_delete_kafka_group_config
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
batch_alter_group_configs Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Batch alter configurations for the specified group. This API supports consumer groups, share groups, and streams groups.
- Lua path
app.integrations.confluent.batch_alter_group_configs- Full name
confluent.confluent_update_kafka_group_config_batch
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_streams_groups Read
!Early Accesshttps://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8section/Versioning/API-Lifecycle-Policy Return the list of streams groups that belong to the specified Kafka cluster
- Lua path
app.integrations.confluent.list_streams_groups- Full name
confluent.confluent_list_kafka_streams_groups
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_streams_group Read
!Early Accesshttps://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8section/Versioning/API-Lifecycle-Policy Return the streams group specified by the groupid.
- Lua path
app.integrations.confluent.get_streams_group- Full name
confluent.confluent_get_kafka_streams_group
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_streams_group_subtopologies Read
!Early Accesshttps://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8section/Versioning/API-Lifecycle-Policy Return a list of subtopologies that belong to the specified streams group.
- Lua path
app.integrations.confluent.list_streams_group_subtopologies- Full name
confluent.confluent_list_kafka_streams_group_subtopologies
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_streams_group_subtopology Read
!Early Accesshttps://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8section/Versioning/API-Lifecycle-Policy Return the subtopology specified by the subtopologyid.
- Lua path
app.integrations.confluent.get_streams_group_subtopology- Full name
confluent.confluent_get_kafka_streams_group_subtopology
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_streams_group_members Read
!Early Accesshttps://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8section/Versioning/API-Lifecycle-Policy Return a list of members that belong to the specified streams group.
- Lua path
app.integrations.confluent.list_streams_group_members- Full name
confluent.confluent_list_kafka_streams_group_members
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_streams_group_member Read
!Early Accesshttps://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8section/Versioning/API-Lifecycle-Policy Return the members specified by the memberid.
- Lua path
app.integrations.confluent.get_streams_group_member- Full name
confluent.confluent_get_kafka_streams_group_member
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_streams_group_member_assignments Read
!Early Accesshttps://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8section/Versioning/API-Lifecycle-Policy Return the assignments of the member specified by the memberid.
- Lua path
app.integrations.confluent.get_streams_group_member_assignments- Full name
confluent.confluent_get_kafka_streams_group_member_assignments
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_streams_group_member_target_assignments Read
!Early Accesshttps://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8section/Versioning/API-Lifecycle-Policy Return the target assignments of the member specified by the memberid.
- Lua path
app.integrations.confluent.get_streams_group_member_target_assignments- Full name
confluent.confluent_get_kafka_streams_group_member_target_assignments
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_streams_group_assignments_specific_type Read
!Early Accesshttps://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8section/Versioning/API-Lifecycle-Policy Return the tasks of the member specified by the memberid, and the type assignmentstype.
- Lua path
app.integrations.confluent.list_streams_group_assignments_specific_type- Full name
confluent.confluent_list_kafka_streams_group_member_assignment_tasks
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_streams_group_target_assignments_specific_type Read
!Early Accesshttps://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8section/Versioning/API-Lifecycle-Policy Return the target tasks of the member specified by the memberid, and the type assignmentstype.
- Lua path
app.integrations.confluent.list_streams_group_target_assignments_specific_type- Full name
confluent.confluent_list_kafka_streams_group_member_target_assignment_tasks
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_streams_group_assignments_task_partitions_specific_type_and_subtopology Read
!Early Accesshttps://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8section/Versioning/API-Lifecycle-Policy Return the tasks of the member specified by the memberid, and the type assignmentstype.
- Lua path
app.integrations.confluent.list_streams_group_assignments_task_partitions_specific_type_and_subtopology- Full name
confluent.confluent_get_kafka_streams_group_member_assignment_task_partitions
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_streams_group_target_assignments_task_partitions_specific_type_and_subtopology Read
!Early Accesshttps://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8section/Versioning/API-Lifecycle-Policy Return the tasks of the member specified by the memberid, and the type assignmentstype.
- Lua path
app.integrations.confluent.list_streams_group_target_assignments_task_partitions_specific_type_and_subtopology- Full name
confluent.confluent_get_kafka_streams_group_member_target_assignment_task_partitions
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_applied_quotas Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all applied quotas. Shows all quotas for a given scope.
- Lua path
app.integrations.confluent.list_applied_quotas- Full name
confluent.confluent_list_service_quota_v1_applied_quotas
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_applied_quota Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read an applied quota.
- Lua path
app.integrations.confluent.read_applied_quota- Full name
confluent.confluent_get_service_quota_v1_applied_quota
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_scopes Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all scopes.
- Lua path
app.integrations.confluent.list_scopes- Full name
confluent.confluent_list_service_quota_v1_scopes
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_scope Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read a scope.
- Lua path
app.integrations.confluent.read_scope- Full name
confluent.confluent_get_service_quota_v1_scope
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_entitlements Read
!Early Accesshttps://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8section/Versioning/API-Lifecycle-Policy !Request Access To Partner v2https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E. Retrieve a sorted, filtered, paginated list of all entitlements.
- Lua path
app.integrations.confluent.list_entitlements- Full name
confluent.confluent_list_partner_v2_entitlements
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_entitlement Write
!Early Accesshttps://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8section/Versioning/API-Lifecycle-Policy !Request Access To Partner v2https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E. Make a request to create an entitlement.
- Lua path
app.integrations.confluent.create_entitlement- Full name
confluent.confluent_create_partner_v2_entitlement
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_entitlement Read
!Early Accesshttps://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8section/Versioning/API-Lifecycle-Policy !Request Access To Partner v2https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E. Make a request to read an entitlement.
- Lua path
app.integrations.confluent.read_entitlement- Full name
confluent.confluent_get_partner_v2_entitlement
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_regions Read
!Deprecatedhttps://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005csection/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all regions.
- Lua path
app.integrations.confluent.list_regions- Full name
confluent.confluent_list_srcm_v2_regions
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_region Read
!Deprecatedhttps://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005csection/Versioning/API-Lifecycle-Policy Make a request to read a region.
- Lua path
app.integrations.confluent.read_region- Full name
confluent.confluent_get_srcm_v2_region
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_clusters Read
!Deprecatedhttps://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005csection/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all clusters.
- Lua path
app.integrations.confluent.list_clusters- Full name
confluent.confluent_list_srcm_v2_clusters
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_cluster Write
!Deprecatedhttps://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005csection/Versioning/API-Lifecycle-Policy Make a request to create a cluster.
- Lua path
app.integrations.confluent.create_cluster- Full name
confluent.confluent_create_srcm_v2_cluster
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_cluster Read
!Deprecatedhttps://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005csection/Versioning/API-Lifecycle-Policy Make a request to read a cluster.
- Lua path
app.integrations.confluent.read_cluster- Full name
confluent.confluent_get_srcm_v2_cluster
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_cluster Write
!Deprecatedhttps://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005csection/Versioning/API-Lifecycle-Policy Make a request to update a cluster.
- Lua path
app.integrations.confluent.update_cluster- Full name
confluent.confluent_update_srcm_v2_cluster
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_cluster Write
!Deprecatedhttps://img.shields.io/badge/Lifecycle%20Stage-Deprecated-%23ff005csection/Versioning/API-Lifecycle-Policy Make a request to delete a cluster.
- Lua path
app.integrations.confluent.delete_cluster- Full name
confluent.confluent_delete_srcm_v2_cluster
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_clusters Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all clusters.
- Lua path
app.integrations.confluent.list_clusters- Full name
confluent.confluent_list_srcm_v3_clusters
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_cluster Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read a cluster.
- Lua path
app.integrations.confluent.read_cluster- Full name
confluent.confluent_get_srcm_v3_cluster
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_cluster_config Read
Retrieves cluster config information.
- Lua path
app.integrations.confluent.get_cluster_config- Full name
confluent.confluent_get_cluster_config
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
test_schema_compatibility_against_particular_schema_subject_version Write
Test input schema against a particular version of a subject's schema for compatibility. The compatibility level applied for the check is the configured compatibility level for the subject http:get:: /config/string: subject. If this subject's compatibility level was never changed, then the global compatibility level applies http:get:: /config.
- Lua path
app.integrations.confluent.test_schema_compatibility_against_particular_schema_subject_version- Full name
confluent.confluent_test_compatibility_by_subject_name
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
test_schema_compatibility_against_all_schemas_under_subject Write
Test input schema against a subject's schemas for compatibility, based on the configured compatibility level of the subject. In other words, it will perform the same compatibility check as register for that subject. The compatibility level applied for the check is the configured compatibility level for the subject http:get:: /config/string: subject. If this subject's compatibility level was never changed, then the global compatibility level applies http:get:: /config.
- Lua path
app.integrations.confluent.test_schema_compatibility_against_all_schemas_under_subject- Full name
confluent.confluent_test_compatibility_for_subject
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_subject_compatibility_level Read
Retrieves compatibility level, compatibility group, normalization, default metadata, and rule set for a subject.
- Lua path
app.integrations.confluent.get_subject_compatibility_level- Full name
confluent.confluent_get_subject_level_config
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_subject_compatibility_level Write
Update compatibility level, compatibility group, normalization, default metadata, and rule set for the specified subject. On success, echoes the original request back to the client.
- Lua path
app.integrations.confluent.update_subject_compatibility_level- Full name
confluent.confluent_update_subject_level_config
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_subject_compatibility_level Write
Deletes the specified subject-level compatibility level config and reverts to the global default.
- Lua path
app.integrations.confluent.delete_subject_compatibility_level- Full name
confluent.confluent_delete_subject_config
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_global_compatibility_level Read
Retrieves the global compatibility level, compatibility group, normalization, default metadata, and rule set.
- Lua path
app.integrations.confluent.get_global_compatibility_level- Full name
confluent.confluent_get_top_level_config
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_global_compatibility_level Write
Updates the global compatibility level, compatibility group, schema normalization, default metadata, and rule set. On success, echoes the original request back to the client.
- Lua path
app.integrations.confluent.update_global_compatibility_level- Full name
confluent.confluent_update_top_level_config
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_global_compatibility_level Write
Deletes the global compatibility level config and reverts to the default.
- Lua path
app.integrations.confluent.delete_global_compatibility_level- Full name
confluent.confluent_delete_top_level_config
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
gets_all_schema_exporters Read
Retrieves a list of schema exporters that have been created.
- Lua path
app.integrations.confluent.gets_all_schema_exporters- Full name
confluent.confluent_list_exporters
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
creates_new_schema_exporter Write
Creates a new schema exporter. All attributes in request body are optional except config.
- Lua path
app.integrations.confluent.creates_new_schema_exporter- Full name
confluent.confluent_register_exporter
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
gets_schema_exporter_by_name Read
Retrieves the information of the schema exporter.
- Lua path
app.integrations.confluent.gets_schema_exporter_by_name- Full name
confluent.confluent_get_exporter_info_by_name
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_schema_exporter_by_name Write
Updates the information or configurations of the schema exporter. All attributes in request body are optional.
- Lua path
app.integrations.confluent.update_schema_exporter_by_name- Full name
confluent.confluent_update_exporter_info
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_schema_exporter_by_name Write
Deletes the schema exporter.
- Lua path
app.integrations.confluent.delete_schema_exporter_by_name- Full name
confluent.confluent_delete_exporter
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
gets_schema_exporter_status_by_name Read
Retrieves the status of the schema exporter.
- Lua path
app.integrations.confluent.gets_schema_exporter_status_by_name- Full name
confluent.confluent_get_exporter_status_by_name
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
gets_schema_exporter_config_by_name Read
Retrieves the config of the schema exporter.
- Lua path
app.integrations.confluent.gets_schema_exporter_config_by_name- Full name
confluent.confluent_get_exporter_config_by_name
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_schema_exporter_config_by_name Write
Updates the configuration of the schema exporter.
- Lua path
app.integrations.confluent.update_schema_exporter_config_by_name- Full name
confluent.confluent_update_exporter_config_by_name
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
pause_schema_exporter_by_name Write
Pauses the state of the schema exporter.
- Lua path
app.integrations.confluent.pause_schema_exporter_by_name- Full name
confluent.confluent_pause_exporter_by_name
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
reset_schema_exporter_by_name Write
Reset the state of the schema exporter.
- Lua path
app.integrations.confluent.reset_schema_exporter_by_name- Full name
confluent.confluent_reset_exporter_by_name
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
resume_schema_exporter_by_name Write
Resume running of the schema exporter.
- Lua path
app.integrations.confluent.resume_schema_exporter_by_name- Full name
confluent.confluent_resume_exporter_by_name
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_contexts Read
Retrieves a list of contexts.
- Lua path
app.integrations.confluent.list_contexts- Full name
confluent.confluent_list_contexts
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_subject_mode Read
Retrieves the subject mode.
- Lua path
app.integrations.confluent.get_subject_mode- Full name
confluent.confluent_get_mode
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_subject_mode Write
Update mode for the specified subject. On success, echoes the original request back to the client.
- Lua path
app.integrations.confluent.update_subject_mode- Full name
confluent.confluent_update_mode
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_subject_mode Write
Deletes the specified subject-level mode and reverts to the global default.
- Lua path
app.integrations.confluent.delete_subject_mode- Full name
confluent.confluent_delete_subject_mode
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_global_mode Read
Retrieves global mode.
- Lua path
app.integrations.confluent.get_global_mode- Full name
confluent.confluent_get_top_level_mode
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_global_mode Write
Update global mode. On success, echoes the original request back to the client.
- Lua path
app.integrations.confluent.update_global_mode- Full name
confluent.confluent_update_top_level_mode
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_schema_string_by_id Read
Retrieves the schema string identified by the input ID.
- Lua path
app.integrations.confluent.get_schema_string_by_id- Full name
confluent.confluent_get_schema
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_schema_by_id Read
Retrieves the schema identified by the input ID.
- Lua path
app.integrations.confluent.get_schema_by_id- Full name
confluent.confluent_get_schema_only
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_supported_schema_types Read
Retrieve the schema types supported by this registry.
- Lua path
app.integrations.confluent.list_supported_schema_types- Full name
confluent.confluent_get_schema_types
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_schemas Read
Get the schemas matching the specified parameters.
- Lua path
app.integrations.confluent.list_schemas- Full name
confluent.confluent_get_schemas
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_subjects_associated_schema_id Read
Retrieves all the subjects associated with a particular schema ID.
- Lua path
app.integrations.confluent.list_subjects_associated_schema_id- Full name
confluent.confluent_get_subjects
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_subject_versions_associated_schema_id Read
Get all the subject-version pairs associated with the input ID.
- Lua path
app.integrations.confluent.list_subject_versions_associated_schema_id- Full name
confluent.confluent_get_versions
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_schema_by_version Read
Retrieves a specific version of the schema registered under this subject.
- Lua path
app.integrations.confluent.get_schema_by_version- Full name
confluent.confluent_get_schema_by_version
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_schema_version Write
Deletes a specific version of the schema registered under this subject. This only deletes the version and the schema ID remains intact making it still possible to decode data using the schema ID. This API is recommended to be used only in development environments or under extreme circumstances where-in, its required to delete a previously registered schema for compatibility purposes or re-register previously registered schema.
- Lua path
app.integrations.confluent.delete_schema_version- Full name
confluent.confluent_delete_schema_version
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_schemas_referencing_schema Read
Retrieves the IDs of schemas that reference the specified schema.
- Lua path
app.integrations.confluent.list_schemas_referencing_schema- Full name
confluent.confluent_get_referenced_by
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_schema_string_by_version Read
Retrieves the schema for the specified version of this subject. Only the unescaped schema string is returned.
- Lua path
app.integrations.confluent.get_schema_string_by_version- Full name
confluent.confluent_get_schema_only_1
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_versions_under_subject Read
Retrieves a list of versions registered under the specified subject.
- Lua path
app.integrations.confluent.list_versions_under_subject- Full name
confluent.confluent_list_versions
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
register_schema_under_subject Write
Register a new schema under the specified subject. If successfully registered, this returns the unique identifier of this schema in the registry. The returned identifier should be used to retrieve this schema from the schemas resource and is different from the schema's version which is associated with the subject. If the same schema is registered under a different subject, the same identifier will be returned. However, the version of the schema may be different under different subjects. A schema should be compatible with the previously registered schema or schemas if there are any as per the configured compatibility level. The configured compatibility level can be obtained by issuing a GET http:get:: /config/string: subject. If that returns null, then GET http:get:: /config When there are multiple instances of Schema Registry running in the same cluster, the schema registration request will be forwarded to one of the instances designated as the primary. If the primary is not available, the client will get an error code indicating that the forwarding has failed.
- Lua path
app.integrations.confluent.register_schema_under_subject- Full name
confluent.confluent_register
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
lookup_schema_under_subject Write
Check if a schema has already been registered under the specified subject. If so, this returns the schema string along with its globally unique identifier, its version under this subject and the subject name.
- Lua path
app.integrations.confluent.lookup_schema_under_subject- Full name
confluent.confluent_look_up_schema_under_subject
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_subject Write
Deletes the specified subject and its associated compatibility level if registered. It is recommended to use this API only when a topic needs to be recycled or in development environment.
- Lua path
app.integrations.confluent.delete_subject- Full name
confluent.confluent_delete_subject
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_subjects Read
Retrieves a list of registered subjects matching specified parameters.
- Lua path
app.integrations.confluent.list_subjects- Full name
confluent.confluent_list
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
retrieve_latest_version_with_given_metadata Read
Retrieve the latest version with the given metadata.
- Lua path
app.integrations.confluent.retrieve_latest_version_with_given_metadata- Full name
confluent.confluent_get_latest_with_metadata
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_list_kek_names Read
Get a list of kek names
- Lua path
app.integrations.confluent.get_list_kek_names- Full name
confluent.confluent_get_kek_names
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_kek Write
Create a kek
- Lua path
app.integrations.confluent.create_kek- Full name
confluent.confluent_create_kek
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_kek Write
Delete a kek
- Lua path
app.integrations.confluent.delete_kek- Full name
confluent.confluent_delete_kek
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_kek_by_name Read
Get a kek by name
- Lua path
app.integrations.confluent.get_kek_by_name- Full name
confluent.confluent_get_kek
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
alters_kek Write
Alters a kek
- Lua path
app.integrations.confluent.alters_kek- Full name
confluent.confluent_put_kek
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
undelete_kek Write
Undelete a kek
- Lua path
app.integrations.confluent.undelete_kek- Full name
confluent.confluent_undelete_kek
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
test_kek Write
Test a kek
- Lua path
app.integrations.confluent.test_kek- Full name
confluent.confluent_test_kek
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_list_dek_subjects Read
Get a list of dek subjects
- Lua path
app.integrations.confluent.get_list_dek_subjects- Full name
confluent.confluent_get_dek_subjects
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_dek Write
Create a dek
- Lua path
app.integrations.confluent.create_dek- Full name
confluent.confluent_create_dek
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_all_versions_dek Write
Delete all versions of a dek
- Lua path
app.integrations.confluent.delete_all_versions_dek- Full name
confluent.confluent_delete_dek_versions
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_dek_by_subject Read
Get a dek by subject
- Lua path
app.integrations.confluent.get_dek_by_subject- Full name
confluent.confluent_get_dek
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_dek_version Write
Delete a dek version
- Lua path
app.integrations.confluent.delete_dek_version- Full name
confluent.confluent_delete_dek_version
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
get_dek_by_subject_and_version Read
Get a dek by subject and version
- Lua path
app.integrations.confluent.get_dek_by_subject_and_version- Full name
confluent.confluent_get_dek_by_version
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_versions_dek Read
List versions of dek
- Lua path
app.integrations.confluent.list_versions_dek- Full name
confluent.confluent_get_dek_versions
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
undelete_dek_version Write
Undelete a dek version
- Lua path
app.integrations.confluent.undelete_dek_version- Full name
confluent.confluent_undelete_dek_version
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
undelete_all_versions_dek Write
Undelete all versions of a dek
- Lua path
app.integrations.confluent.undelete_all_versions_dek- Full name
confluent.confluent_undelete_dek_versions
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
bulk_read_business_metadata_definitions Read
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Bulk retrieval API for retrieving business metadata definitions.
- Lua path
app.integrations.confluent.bulk_read_business_metadata_definitions- Full name
confluent.confluent_get_all_business_metadata_defs
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
bulk_create_business_metadata_definitions Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Bulk create API for business metadata definitions.
- Lua path
app.integrations.confluent.bulk_create_business_metadata_definitions- Full name
confluent.confluent_create_business_metadata_defs
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
bulk_update_business_metadata_definitions Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Bulk update API for business metadata definitions.
- Lua path
app.integrations.confluent.bulk_update_business_metadata_definitions- Full name
confluent.confluent_update_business_metadata_defs
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_business_metadata_definition Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Delete API for business metadata definition identified by its name.
- Lua path
app.integrations.confluent.delete_business_metadata_definition- Full name
confluent.confluent_delete_business_metadata_def
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_business_metadata_definition Read
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Get the business metadata definition with the given name.
- Lua path
app.integrations.confluent.read_business_metadata_definition- Full name
confluent.confluent_get_business_metadata_def_by_name
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
bulk_create_business_metadata Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Bulk API to create multiple business metadata.
- Lua path
app.integrations.confluent.bulk_create_business_metadata- Full name
confluent.confluent_create_business_metadata
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
bulk_update_business_metadata Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Bulk API to update multiple business metadata.
- Lua path
app.integrations.confluent.bulk_update_business_metadata- Full name
confluent.confluent_update_business_metadata
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_business_metadata_entity Read
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Gets the list of business metadata for a given entity represented by a qualified name.
- Lua path
app.integrations.confluent.read_business_metadata_entity- Full name
confluent.confluent_get_business_metadata
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_business_metadata_entity Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Delete a business metadata on an entity.
- Lua path
app.integrations.confluent.delete_business_metadata_entity- Full name
confluent.confluent_delete_business_metadata
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
bulk_update_tags Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Bulk API to update multiple tags.
- Lua path
app.integrations.confluent.bulk_update_tags- Full name
confluent.confluent_update_tags
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
bulk_create_tags Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Bulk API to create multiple tags.
- Lua path
app.integrations.confluent.bulk_create_tags- Full name
confluent.confluent_create_tags
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_entity Read
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Fetch complete definition of an entity given its type and unique attribute.
- Lua path
app.integrations.confluent.read_entity- Full name
confluent.confluent_get_by_unique_attributes
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_tags_entity Read
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Gets the list of tags for a given entity represented by a qualified name.
- Lua path
app.integrations.confluent.read_tags_entity- Full name
confluent.confluent_get_tags
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_entity_attribute Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Partially update an entity attribute.
- Lua path
app.integrations.confluent.update_entity_attribute- Full name
confluent.confluent_partial_entity_update
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_tag_entity Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Delete a tag for an entity.
- Lua path
app.integrations.confluent.delete_tag_entity- Full name
confluent.confluent_delete_tag
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
search_by_attribute Read
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve data for the specified attribute search query.
- Lua path
app.integrations.confluent.search_by_attribute- Full name
confluent.confluent_search_using_attribute
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
search_by_fulltext_query Read
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve data for the specified fulltext query.
- Lua path
app.integrations.confluent.search_by_fulltext_query- Full name
confluent.confluent_search_using_basic
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
bulk_read_tag_definitions Read
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Bulk retrieval API for retrieving tag definitions.
- Lua path
app.integrations.confluent.bulk_read_tag_definitions- Full name
confluent.confluent_get_all_tag_defs
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
bulk_update_tag_definitions Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Bulk update API for tag definitions.
- Lua path
app.integrations.confluent.bulk_update_tag_definitions- Full name
confluent.confluent_update_tag_defs
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
bulk_create_tag_definitions Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Bulk create API for tag definitions.
- Lua path
app.integrations.confluent.bulk_create_tag_definitions- Full name
confluent.confluent_create_tag_defs
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_tag_definition Read
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Get the tag definition with the given name.
- Lua path
app.integrations.confluent.read_tag_definition- Full name
confluent.confluent_get_tag_def_by_name
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_tag_definition Write
!Generally Availablehttps://img.shields.io/badge/Lifecycle%20Stage-Generally%20Available-%2345c6e8section/Versioning/API-Lifecycle-Policy Delete API for tag definition identified by its name.
- Lua path
app.integrations.confluent.delete_tag_definition- Full name
confluent.confluent_delete_tag_def
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
resend Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Resend provider share
- Lua path
app.integrations.confluent.resend- Full name
confluent.confluent_resend_cdx_v1_provider_share
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
redeem_token Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Redeem the shared token for shared topic and cluster access information
- Lua path
app.integrations.confluent.redeem_token- Full name
confluent.confluent_redeem_cdx_v1_shared_token
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_organization_stream_sharing_opt_settings Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Returns the organization's stream sharing opt-in settings.
- Lua path
app.integrations.confluent.read_organization_stream_sharing_opt_settings- Full name
confluent.confluent_get_cdx_v1_opt_in
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
set_organization_stream_sharing_opt_settings Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Updates the organization's stream sharing opt-in settings.
- Lua path
app.integrations.confluent.set_organization_stream_sharing_opt_settings- Full name
confluent.confluent_update_cdx_v1_opt_in
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_organization Read
!Early Accesshttps://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8section/Versioning/API-Lifecycle-Policy !Request Access To Partner v2https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E. Make a request to read an organization.
- Lua path
app.integrations.confluent.read_organization- Full name
confluent.confluent_get_partner_v2_organization
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_organizations Read
!Early Accesshttps://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8section/Versioning/API-Lifecycle-Policy !Request Access To Partner v2https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E. Retrieve a sorted, filtered, paginated list of all organizations.
- Lua path
app.integrations.confluent.list_organizations- Full name
confluent.confluent_list_partner_v2_organizations
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
signup_organization_behalf_customer Write
!Early Accesshttps://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8section/Versioning/API-Lifecycle-Policy !Request Access To Partner v2https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E. Create an organization for a customer. You must pass in either an entitlement object reference a url to a previously created entitlement or entitlement details. If you pass in an entitlement object reference, we will link with the created entitlement. If you pass in the entitlement details, we will create the entitlement with the organization in a single transaction. If you pass in user details email, given name, and family name, we will create a user as well. If you do not pass in user details, you MUST call /partner/v2/signup/activate with user details to complete signup.
- Lua path
app.integrations.confluent.signup_organization_behalf_customer- Full name
confluent.confluent_signup
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
activate_incomplete_signup Write
!Early Accesshttps://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8section/Versioning/API-Lifecycle-Policy !Request Access To Partner v2https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E. Creates a user in the organization previously created in /partner/v2/signup. This completes the signup process if you did not pass in user details to /partner/v2/signup. Calling this endpoint if the signup process has been completed will result in a 409 Conflict error.
- Lua path
app.integrations.confluent.activate_incomplete_signup- Full name
confluent.confluent_activate_signup
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
signup_customer_by_linking_existing_organization Write
!Early Accesshttps://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8section/Versioning/API-Lifecycle-Policy !Request Access To Partner v2https://img.shields.io/badge/-Request%20Access%20To%20Partner%20v2-%23bc8540mailto:ccloud-api-access+partner-v2-early-access@confluent.io?subject=Request%20to%20join%20partner/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20partner/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E. Signup a customer by linking a new entitlement to an existing Confluent Cloud organization.
- Lua path
app.integrations.confluent.signup_customer_by_linking_existing_organization- Full name
confluent.confluent_signup_partner_v2_link
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_networks Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all networks.
- Lua path
app.integrations.confluent.list_networks- Full name
confluent.confluent_list_networking_v1_networks
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_network Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create a network.
- Lua path
app.integrations.confluent.create_network- Full name
confluent.confluent_create_networking_v1_network
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_network Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read a network.
- Lua path
app.integrations.confluent.read_network- Full name
confluent.confluent_get_networking_v1_network
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_network Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update a network.
- Lua path
app.integrations.confluent.update_network- Full name
confluent.confluent_update_networking_v1_network
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_network Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete a network.
- Lua path
app.integrations.confluent.delete_network- Full name
confluent.confluent_delete_networking_v1_network
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_peerings Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all peerings.
- Lua path
app.integrations.confluent.list_peerings- Full name
confluent.confluent_list_networking_v1_peerings
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_peering Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create a peering.
- Lua path
app.integrations.confluent.create_peering- Full name
confluent.confluent_create_networking_v1_peering
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_peering Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read a peering.
- Lua path
app.integrations.confluent.read_peering- Full name
confluent.confluent_get_networking_v1_peering
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_peering Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update a peering.
- Lua path
app.integrations.confluent.update_peering- Full name
confluent.confluent_update_networking_v1_peering
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_peering Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete a peering.
- Lua path
app.integrations.confluent.delete_peering- Full name
confluent.confluent_delete_networking_v1_peering
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_transit_gateway_attachments Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all transit gateway attachments.
- Lua path
app.integrations.confluent.list_transit_gateway_attachments- Full name
confluent.confluent_list_networking_v1_transit_gateway_attachments
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_transit_gateway_attachment Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create a transit gateway attachment.
- Lua path
app.integrations.confluent.create_transit_gateway_attachment- Full name
confluent.confluent_create_networking_v1_transit_gateway_attachment
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_transit_gateway_attachment Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read a transit gateway attachment.
- Lua path
app.integrations.confluent.read_transit_gateway_attachment- Full name
confluent.confluent_get_networking_v1_transit_gateway_attachment
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_transit_gateway_attachment Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update a transit gateway attachment.
- Lua path
app.integrations.confluent.update_transit_gateway_attachment- Full name
confluent.confluent_update_networking_v1_transit_gateway_attachment
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_transit_gateway_attachment Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete a transit gateway attachment.
- Lua path
app.integrations.confluent.delete_transit_gateway_attachment- Full name
confluent.confluent_delete_networking_v1_transit_gateway_attachment
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_private_link_accesses Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all private link accesses.
- Lua path
app.integrations.confluent.list_private_link_accesses- Full name
confluent.confluent_list_networking_v1_private_link_accesses
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_private_link_access Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create a private link access.
- Lua path
app.integrations.confluent.create_private_link_access- Full name
confluent.confluent_create_networking_v1_private_link_access
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_private_link_access Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read a private link access.
- Lua path
app.integrations.confluent.read_private_link_access- Full name
confluent.confluent_get_networking_v1_private_link_access
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_private_link_access Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update a private link access.
- Lua path
app.integrations.confluent.update_private_link_access- Full name
confluent.confluent_update_networking_v1_private_link_access
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_private_link_access Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete a private link access.
- Lua path
app.integrations.confluent.delete_private_link_access- Full name
confluent.confluent_delete_networking_v1_private_link_access
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_network_link_services Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all network link services.
- Lua path
app.integrations.confluent.list_network_link_services- Full name
confluent.confluent_list_networking_v1_network_link_services
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_network_link_service Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create a network link service.
- Lua path
app.integrations.confluent.create_network_link_service- Full name
confluent.confluent_create_networking_v1_network_link_service
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_network_link_service Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read a network link service.
- Lua path
app.integrations.confluent.read_network_link_service- Full name
confluent.confluent_get_networking_v1_network_link_service
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_network_link_service Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update a network link service.
- Lua path
app.integrations.confluent.update_network_link_service- Full name
confluent.confluent_update_networking_v1_network_link_service
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_network_link_service Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete a network link service.
- Lua path
app.integrations.confluent.delete_network_link_service- Full name
confluent.confluent_delete_networking_v1_network_link_service
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_network_link_endpoints Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all network link endpoints.
- Lua path
app.integrations.confluent.list_network_link_endpoints- Full name
confluent.confluent_list_networking_v1_network_link_endpoints
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_network_link_endpoint Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create a network link endpoint.
- Lua path
app.integrations.confluent.create_network_link_endpoint- Full name
confluent.confluent_create_networking_v1_network_link_endpoint
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_network_link_endpoint Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read a network link endpoint.
- Lua path
app.integrations.confluent.read_network_link_endpoint- Full name
confluent.confluent_get_networking_v1_network_link_endpoint
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_network_link_endpoint Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update a network link endpoint.
- Lua path
app.integrations.confluent.update_network_link_endpoint- Full name
confluent.confluent_update_networking_v1_network_link_endpoint
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_network_link_endpoint Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete a network link endpoint.
- Lua path
app.integrations.confluent.delete_network_link_endpoint- Full name
confluent.confluent_delete_networking_v1_network_link_endpoint
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_network_link_service_associations Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all network link service associations.
- Lua path
app.integrations.confluent.list_network_link_service_associations- Full name
confluent.confluent_list_networking_v1_network_link_service_associations
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_network_link_service_association Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read a network link service association.
- Lua path
app.integrations.confluent.read_network_link_service_association- Full name
confluent.confluent_get_networking_v1_network_link_service_association
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_ip_addresses Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Related guide: Use Public Egress IP addresses on Confluent Cloudhttps://docs.confluent.io/cloud/current/networking/static-egress-ip-addresses.html Retrieve a sorted, filtered, paginated list of all IP Addresses.
- Lua path
app.integrations.confluent.list_ip_addresses- Full name
confluent.confluent_list_networking_v1_ip_addresses
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_private_link_attachments Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all private link attachments.
- Lua path
app.integrations.confluent.list_private_link_attachments- Full name
confluent.confluent_list_networking_v1_private_link_attachments
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_private_link_attachment Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create a private link attachment.
- Lua path
app.integrations.confluent.create_private_link_attachment- Full name
confluent.confluent_create_networking_v1_private_link_attachment
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_private_link_attachment Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read a private link attachment.
- Lua path
app.integrations.confluent.read_private_link_attachment- Full name
confluent.confluent_get_networking_v1_private_link_attachment
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_private_link_attachment Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update a private link attachment.
- Lua path
app.integrations.confluent.update_private_link_attachment- Full name
confluent.confluent_update_networking_v1_private_link_attachment
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_private_link_attachment Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete a private link attachment.
- Lua path
app.integrations.confluent.delete_private_link_attachment- Full name
confluent.confluent_delete_networking_v1_private_link_attachment
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_private_link_attachment_connections Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all private link attachment connections.
- Lua path
app.integrations.confluent.list_private_link_attachment_connections- Full name
confluent.confluent_list_networking_v1_private_link_attachment_connections
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_private_link_attachment_connection Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create a private link attachment connection.
- Lua path
app.integrations.confluent.create_private_link_attachment_connection- Full name
confluent.confluent_create_networking_v1_private_link_attachment_connection
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_private_link_attachment_connection Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read a private link attachment connection.
- Lua path
app.integrations.confluent.read_private_link_attachment_connection- Full name
confluent.confluent_get_networking_v1_private_link_attachment_connection
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_private_link_attachment_connection Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update a private link attachment connection.
- Lua path
app.integrations.confluent.update_private_link_attachment_connection- Full name
confluent.confluent_update_networking_v1_private_link_attachment_connection
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_private_link_attachment_connection Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete a private link attachment connection.
- Lua path
app.integrations.confluent.delete_private_link_attachment_connection- Full name
confluent.confluent_delete_networking_v1_private_link_attachment_connection
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_identity_providers Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all identity providers.
- Lua path
app.integrations.confluent.list_identity_providers- Full name
confluent.confluent_list_iam_v2_identity_providers
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_identity_provider Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create an identity provider.
- Lua path
app.integrations.confluent.create_identity_provider- Full name
confluent.confluent_create_iam_v2_identity_provider
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_identity_provider Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read an identity provider.
- Lua path
app.integrations.confluent.read_identity_provider- Full name
confluent.confluent_get_iam_v2_identity_provider
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_identity_provider Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update an identity provider.
- Lua path
app.integrations.confluent.update_identity_provider- Full name
confluent.confluent_update_iam_v2_identity_provider
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_identity_provider Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete an identity provider.
- Lua path
app.integrations.confluent.delete_identity_provider- Full name
confluent.confluent_delete_iam_v2_identity_provider
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
refresh_provider_jwks Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to refresh the provider's JWKS
- Lua path
app.integrations.confluent.refresh_provider_jwks- Full name
confluent.confluent_refresh_iam_v2_json_web_key_set
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_identity_pools Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all identity pools.
- Lua path
app.integrations.confluent.list_identity_pools- Full name
confluent.confluent_list_iam_v2_identity_pools
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_identity_pool Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create an identity pool.
- Lua path
app.integrations.confluent.create_identity_pool- Full name
confluent.confluent_create_iam_v2_identity_pool
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_identity_pool Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read an identity pool.
- Lua path
app.integrations.confluent.read_identity_pool- Full name
confluent.confluent_get_iam_v2_identity_pool
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_identity_pool Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update an identity pool.
- Lua path
app.integrations.confluent.update_identity_pool- Full name
confluent.confluent_update_iam_v2_identity_pool
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_identity_pool Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete an identity pool.
- Lua path
app.integrations.confluent.delete_identity_pool- Full name
confluent.confluent_delete_iam_v2_identity_pool
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
exchange_oauth_token Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Use this operation to exchange an access token JWT issued by an external identity provider for an access token JWT issued by Confluent.This enables the use of external identities to access Confluent Cloud APIs.
- Lua path
app.integrations.confluent.exchange_oauth_token- Full name
confluent.confluent_exchange_sts_v1_oauth_token
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_client_quotas Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all client quotas.
- Lua path
app.integrations.confluent.list_client_quotas- Full name
confluent.confluent_list_kafka_quotas_v1_client_quotas
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_client_quota Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create a client quota.
- Lua path
app.integrations.confluent.create_client_quota- Full name
confluent.confluent_create_kafka_quotas_v1_client_quota
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_client_quota Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read a client quota.
- Lua path
app.integrations.confluent.read_client_quota- Full name
confluent.confluent_get_kafka_quotas_v1_client_quota
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_client_quota Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update a client quota.
- Lua path
app.integrations.confluent.update_client_quota- Full name
confluent.confluent_update_kafka_quotas_v1_client_quota
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_client_quota Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete a client quota.
- Lua path
app.integrations.confluent.delete_client_quota- Full name
confluent.confluent_delete_kafka_quotas_v1_client_quota
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_keys Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all keys.
- Lua path
app.integrations.confluent.list_keys- Full name
confluent.confluent_list_byok_v1_keys
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_key Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create a key.
- Lua path
app.integrations.confluent.create_key- Full name
confluent.confluent_create_byok_v1_key
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_key Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read a key.
- Lua path
app.integrations.confluent.read_key- Full name
confluent.confluent_get_byok_v1_key
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_key Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update a key.
- Lua path
app.integrations.confluent.update_key- Full name
confluent.confluent_update_byok_v1_key
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_key Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete a key.
- Lua path
app.integrations.confluent.delete_key- Full name
confluent.confluent_delete_byok_v1_key
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_costs Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all costs.
- Lua path
app.integrations.confluent.list_costs- Full name
confluent.confluent_list_billing_v1_costs
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_group_mappings Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all group mappings.
- Lua path
app.integrations.confluent.list_group_mappings- Full name
confluent.confluent_list_iam_v2_sso_group_mappings
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_group_mapping Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create a group mapping.
- Lua path
app.integrations.confluent.create_group_mapping- Full name
confluent.confluent_create_iam_v2_sso_group_mapping
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_group_mapping Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read a group mapping.
- Lua path
app.integrations.confluent.read_group_mapping- Full name
confluent.confluent_get_iam_v2_sso_group_mapping
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_group_mapping Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update a group mapping.
- Lua path
app.integrations.confluent.update_group_mapping- Full name
confluent.confluent_update_iam_v2_sso_group_mapping
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_group_mapping Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete a group mapping.
- Lua path
app.integrations.confluent.delete_group_mapping- Full name
confluent.confluent_delete_iam_v2_sso_group_mapping
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_compute_pools Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all compute pools.
- Lua path
app.integrations.confluent.list_compute_pools- Full name
confluent.confluent_list_fcpm_v2_compute_pools
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_compute_pool Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create a compute pool.
- Lua path
app.integrations.confluent.create_compute_pool- Full name
confluent.confluent_create_fcpm_v2_compute_pool
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_compute_pool Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read a compute pool.
- Lua path
app.integrations.confluent.read_compute_pool- Full name
confluent.confluent_get_fcpm_v2_compute_pool
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_compute_pool Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update a compute pool.
- Lua path
app.integrations.confluent.update_compute_pool- Full name
confluent.confluent_update_fcpm_v2_compute_pool
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_compute_pool Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete a compute pool.
- Lua path
app.integrations.confluent.delete_compute_pool- Full name
confluent.confluent_delete_fcpm_v2_compute_pool
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_regions Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all regions.
- Lua path
app.integrations.confluent.list_regions- Full name
confluent.confluent_list_fcpm_v2_regions
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_org_compute_pool_config Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read an org compute pool config.
- Lua path
app.integrations.confluent.read_org_compute_pool_config- Full name
confluent.confluent_get_fcpm_v2_org_compute_pool_config
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_org_compute_pool_config Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update an org compute pool config.
- Lua path
app.integrations.confluent.update_org_compute_pool_config- Full name
confluent.confluent_update_fcpm_v2_org_compute_pool_config
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_connections Read
!Previewhttps://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afbasection/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered and paginated list of all Connections.
- Lua path
app.integrations.confluent.list_connections- Full name
confluent.confluent_list_sqlv1_connections
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_connection Write
!Previewhttps://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afbasection/Versioning/API-Lifecycle-Policy Make a request to create a Connection.
- Lua path
app.integrations.confluent.create_connection- Full name
confluent.confluent_create_sqlv1_connection
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_connection Read
!Previewhttps://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afbasection/Versioning/API-Lifecycle-Policy Make a request to read a Connection.
- Lua path
app.integrations.confluent.read_connection- Full name
confluent.confluent_get_sqlv1_connection
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_connection Write
!Previewhttps://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afbasection/Versioning/API-Lifecycle-Policy Make a request to delete a statement.
- Lua path
app.integrations.confluent.delete_connection- Full name
confluent.confluent_delete_sqlv1_connection
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_connection Write
!Previewhttps://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afbasection/Versioning/API-Lifecycle-Policy Make a request to update a connection.
- Lua path
app.integrations.confluent.update_connection- Full name
confluent.confluent_update_sqlv1_connection
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_statement_result Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Read Statement Result.
- Lua path
app.integrations.confluent.read_statement_result- Full name
confluent.confluent_get_sqlv1_statement_result
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_statements Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all statements.
- Lua path
app.integrations.confluent.list_statements- Full name
confluent.confluent_list_sqlv1_statements
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_statement Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create a statement.
- Lua path
app.integrations.confluent.create_statement- Full name
confluent.confluent_create_sqlv1_statement
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_statement Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read a statement.
- Lua path
app.integrations.confluent.read_statement- Full name
confluent.confluent_get_sqlv1_statement
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_statement Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete a statement.
- Lua path
app.integrations.confluent.delete_statement- Full name
confluent.confluent_delete_sqlv1_statement
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_statement Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update a statement. The request will fail with a 409 Conflict error if the Statement has changed since it was fetched. In this case, do a GET, reapply the modifications, and try the update again.
- Lua path
app.integrations.confluent.update_statement- Full name
confluent.confluent_update_sqlv1_statement
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
patch_statement Write
!Early Accesshttps://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to patch a statement.
- Lua path
app.integrations.confluent.patch_statement- Full name
confluent.confluent_patch_sqlv1_statement
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_statement_exceptions Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a list of the 10 most recent statement exceptions.
- Lua path
app.integrations.confluent.list_statement_exceptions- Full name
confluent.confluent_get_sqlv1_statement_exceptions
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_all_materialized_tables Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted and paginated list of all materialized tables.
- Lua path
app.integrations.confluent.list_all_materialized_tables- Full name
confluent.confluent_list_sqlv1_materialized_tables
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_materialized_table Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Create a new Materialized Table.
- Lua path
app.integrations.confluent.create_materialized_table- Full name
confluent.confluent_create_sqlv1_materialized_table
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_materialized_table Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a specific Materialized Table by name.
- Lua path
app.integrations.confluent.read_materialized_table- Full name
confluent.confluent_get_sqlv1_materialized_table
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_evolve_materialized_table Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update a Materialized Table's mutable fields. Mutable fields include: query, stopped, computepoolid, principal, columns, watermark, constraints and tableoptions.
- Lua path
app.integrations.confluent.update_evolve_materialized_table- Full name
confluent.confluent_update_sqlv1_materialized_table
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_materialized_table Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Delete a specific Materialized Table by name.
- Lua path
app.integrations.confluent.delete_materialized_table- Full name
confluent.confluent_delete_sqlv1_materialized_table
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_all_versions_materialized_table Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted and paginated list of all versions for a specific Materialized Table.
- Lua path
app.integrations.confluent.list_all_versions_materialized_table- Full name
confluent.confluent_list_sqlv1_materialized_table_versions
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_materialized_table_version Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a specific version of a Materialized Table.
- Lua path
app.integrations.confluent.read_materialized_table_version- Full name
confluent.confluent_get_sqlv1_materialized_table_version
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_all_agents Read
!Previewhttps://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300af91section/Versioning/API-Lifecycle-Policy Retrieve a sorted and paginated list of all agents.
- Lua path
app.integrations.confluent.list_all_agents- Full name
confluent.confluent_list_sqlv1_agents
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_agent Write
!Previewhttps://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300af91section/Versioning/API-Lifecycle-Policy Make a request to create an Agent.
- Lua path
app.integrations.confluent.create_agent- Full name
confluent.confluent_create_sqlv1_agent
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_agent Read
!Previewhttps://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300af91section/Versioning/API-Lifecycle-Policy Retrieve a specific Agent by name.
- Lua path
app.integrations.confluent.read_agent- Full name
confluent.confluent_get_sqlv1_agent
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
alter_agent Write
!Previewhttps://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300af91section/Versioning/API-Lifecycle-Policy Make a request to update an Agent's mutable fields. Mutable fields include: description, model, prompt, and properties.
- Lua path
app.integrations.confluent.alter_agent- Full name
confluent.confluent_update_sqlv1_agent
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_agent Write
!Previewhttps://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300af91section/Versioning/API-Lifecycle-Policy Delete a specific Agent by name.
- Lua path
app.integrations.confluent.delete_agent- Full name
confluent.confluent_delete_sqlv1_agent
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_tool Write
!Previewhttps://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afbasection/Versioning/API-Lifecycle-Policy Make a request to create a Tool.
- Lua path
app.integrations.confluent.create_tool- Full name
confluent.confluent_create_sqlv1_tool
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_tools Read
!Previewhttps://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afbasection/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all Tools.
- Lua path
app.integrations.confluent.list_tools- Full name
confluent.confluent_list_sqlv1_tools
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_tool Read
!Previewhttps://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afbasection/Versioning/API-Lifecycle-Policy Make a request to read a Tool.
- Lua path
app.integrations.confluent.read_tool- Full name
confluent.confluent_get_sqlv1_tool
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_tool Write
!Previewhttps://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afbasection/Versioning/API-Lifecycle-Policy Make a request to delete a Tool.
- Lua path
app.integrations.confluent.delete_tool- Full name
confluent.confluent_delete_sqlv1_tool
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_dns_forwarders Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all DNS forwarders.
- Lua path
app.integrations.confluent.list_dns_forwarders- Full name
confluent.confluent_list_networking_v1_dns_forwarders
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_dns_forwarder Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create a DNS forwarder.
- Lua path
app.integrations.confluent.create_dns_forwarder- Full name
confluent.confluent_create_networking_v1_dns_forwarder
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_dns_forwarder Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read a DNS forwarder.
- Lua path
app.integrations.confluent.read_dns_forwarder- Full name
confluent.confluent_get_networking_v1_dns_forwarder
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_dns_forwarder Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update a DNS forwarder.
- Lua path
app.integrations.confluent.update_dns_forwarder- Full name
confluent.confluent_update_networking_v1_dns_forwarder
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_dns_forwarder Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete a DNS forwarder.
- Lua path
app.integrations.confluent.delete_dns_forwarder- Full name
confluent.confluent_delete_networking_v1_dns_forwarder
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_access_points Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all access points.
- Lua path
app.integrations.confluent.list_access_points- Full name
confluent.confluent_list_networking_v1_access_points
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_access_point Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create an access point.
- Lua path
app.integrations.confluent.create_access_point- Full name
confluent.confluent_create_networking_v1_access_point
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_access_point Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read an access point.
- Lua path
app.integrations.confluent.read_access_point- Full name
confluent.confluent_get_networking_v1_access_point
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_access_point Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update an access point.
- Lua path
app.integrations.confluent.update_access_point- Full name
confluent.confluent_update_networking_v1_access_point
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_access_point Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete an access point.
- Lua path
app.integrations.confluent.delete_access_point- Full name
confluent.confluent_delete_networking_v1_access_point
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_dns_records Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all DNS records.
- Lua path
app.integrations.confluent.list_dns_records- Full name
confluent.confluent_list_networking_v1_dns_records
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_dns_record Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create a DNS record.
- Lua path
app.integrations.confluent.create_dns_record- Full name
confluent.confluent_create_networking_v1_dns_record
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_dns_record Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read a DNS record.
- Lua path
app.integrations.confluent.read_dns_record- Full name
confluent.confluent_get_networking_v1_dns_record
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_dns_record Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update a DNS record.
- Lua path
app.integrations.confluent.update_dns_record- Full name
confluent.confluent_update_networking_v1_dns_record
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_dns_record Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete a DNS record.
- Lua path
app.integrations.confluent.delete_dns_record- Full name
confluent.confluent_delete_networking_v1_dns_record
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_certificate_authorities Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all certificate authorities.
- Lua path
app.integrations.confluent.list_certificate_authorities- Full name
confluent.confluent_list_iam_v2_certificate_authorities
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_certificate_authority Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create a certificate authority.
- Lua path
app.integrations.confluent.create_certificate_authority- Full name
confluent.confluent_create_iam_v2_certificate_authority
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_certificate_authority Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read a certificate authority.
- Lua path
app.integrations.confluent.read_certificate_authority- Full name
confluent.confluent_get_iam_v2_certificate_authority
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_certificate_authority Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update a certificate authority.
- Lua path
app.integrations.confluent.update_certificate_authority- Full name
confluent.confluent_update_iam_v2_certificate_authority
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_certificate_authority Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete a certificate authority.
- Lua path
app.integrations.confluent.delete_certificate_authority- Full name
confluent.confluent_delete_iam_v2_certificate_authority
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_certificate_identity_pools Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all certificate identity pools.
- Lua path
app.integrations.confluent.list_certificate_identity_pools- Full name
confluent.confluent_list_iam_v2_certificate_identity_pools
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_certificate_identity_pool Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create a certificate identity pool.
- Lua path
app.integrations.confluent.create_certificate_identity_pool- Full name
confluent.confluent_create_iam_v2_certificate_identity_pool
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_certificate_identity_pool Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read a certificate identity pool.
- Lua path
app.integrations.confluent.read_certificate_identity_pool- Full name
confluent.confluent_get_iam_v2_certificate_identity_pool
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_certificate_identity_pool Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update a certificate identity pool.
- Lua path
app.integrations.confluent.update_certificate_identity_pool- Full name
confluent.confluent_update_iam_v2_certificate_identity_pool
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_certificate_identity_pool Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete a certificate identity pool.
- Lua path
app.integrations.confluent.delete_certificate_identity_pool- Full name
confluent.confluent_delete_iam_v2_certificate_identity_pool
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_integrations Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all integrations. If no provider filter is specified, returns provider integrations from all clouds.
- Lua path
app.integrations.confluent.list_integrations- Full name
confluent.confluent_list_pim_v1_integrations
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_integration Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create an integration.
- Lua path
app.integrations.confluent.create_integration- Full name
confluent.confluent_create_pim_v1_integration
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_integration Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read an integration.
- Lua path
app.integrations.confluent.read_integration- Full name
confluent.confluent_get_pim_v1_integration
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_integration Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete an integration. This request fails if existing workloads are using this CSP integration.
- Lua path
app.integrations.confluent.delete_integration- Full name
confluent.confluent_delete_pim_v1_integration
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_integrations Read
!Early Accesshttps://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8section/Versioning/API-Lifecycle-Policy !Request Access To Provider Integrationhttps://img.shields.io/badge/-Request%20Access%20To%20Provider%20Integration-%23bc8540mailto:ccloud-api-access+pim-v2-early-access@confluent.io?subject=Request%20to%20join%20pim/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20pim/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E. Retrieve a sorted, filtered, paginated list of all integrations. If no provider filter is specified, returns provider integrations from all clouds.
- Lua path
app.integrations.confluent.list_integrations- Full name
confluent.confluent_list_pim_v2_integrations
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_integration Write
!Early Accesshttps://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8section/Versioning/API-Lifecycle-Policy !Request Access To Provider Integrationhttps://img.shields.io/badge/-Request%20Access%20To%20Provider%20Integration-%23bc8540mailto:ccloud-api-access+pim-v2-early-access@confluent.io?subject=Request%20to%20join%20pim/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20pim/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E. Make a request to create an integration.
- Lua path
app.integrations.confluent.create_integration- Full name
confluent.confluent_create_pim_v2_integration
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_integration Read
!Early Accesshttps://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8section/Versioning/API-Lifecycle-Policy !Request Access To Provider Integrationhttps://img.shields.io/badge/-Request%20Access%20To%20Provider%20Integration-%23bc8540mailto:ccloud-api-access+pim-v2-early-access@confluent.io?subject=Request%20to%20join%20pim/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20pim/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E. Make a request to read an integration.
- Lua path
app.integrations.confluent.read_integration- Full name
confluent.confluent_get_pim_v2_integration
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_integration Write
!Early Accesshttps://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8section/Versioning/API-Lifecycle-Policy !Request Access To Provider Integrationhttps://img.shields.io/badge/-Request%20Access%20To%20Provider%20Integration-%23bc8540mailto:ccloud-api-access+pim-v2-early-access@confluent.io?subject=Request%20to%20join%20pim/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20pim/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E. Make a request to update an integration. This request only works for integrations with DRAFT status.
- Lua path
app.integrations.confluent.update_integration- Full name
confluent.confluent_update_pim_v2_integration
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_integration Write
!Early Accesshttps://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8section/Versioning/API-Lifecycle-Policy !Request Access To Provider Integrationhttps://img.shields.io/badge/-Request%20Access%20To%20Provider%20Integration-%23bc8540mailto:ccloud-api-access+pim-v2-early-access@confluent.io?subject=Request%20to%20join%20pim/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20pim/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E. Make a request to delete an integration. This request fails if existing workloads are using this CSP integration.
- Lua path
app.integrations.confluent.delete_integration- Full name
confluent.confluent_delete_pim_v2_integration
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
validate_integration Write
!Early Accesshttps://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8section/Versioning/API-Lifecycle-Policy !Request Access To Provider Integrationhttps://img.shields.io/badge/-Request%20Access%20To%20Provider%20Integration-%23bc8540mailto:ccloud-api-access+pim-v2-early-access@confluent.io?subject=Request%20to%20join%20pim/v2%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20pim/v2%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E. Validate the provider integration configuration.
- Lua path
app.integrations.confluent.validate_integration- Full name
confluent.confluent_validate_pim_v2_integration
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_flink_artifacts Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all flink artifacts.
- Lua path
app.integrations.confluent.list_flink_artifacts- Full name
confluent.confluent_list_artifact_v1_flink_artifacts
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_new_flink_artifact Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create a flink artifact.
- Lua path
app.integrations.confluent.create_new_flink_artifact- Full name
confluent.confluent_create_artifact_v1_flink_artifact
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_flink_artifact Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read a flink artifact.
- Lua path
app.integrations.confluent.read_flink_artifact- Full name
confluent.confluent_get_artifact_v1_flink_artifact
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_flink_artifact Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update a flink artifact.
- Lua path
app.integrations.confluent.update_flink_artifact- Full name
confluent.confluent_update_artifact_v1_flink_artifact
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_flink_artifact Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete a flink artifact.
- Lua path
app.integrations.confluent.delete_flink_artifact- Full name
confluent.confluent_delete_artifact_v1_flink_artifact
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
request_presigned_upload_url_new_flink_artifact Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Request a presigned upload URL to upload a Flink Artifact archive.
- Lua path
app.integrations.confluent.request_presigned_upload_url_new_flink_artifact- Full name
confluent.confluent_presigned_upload_url_artifact_v1_presigned_url
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_gateways Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all gateways.
- Lua path
app.integrations.confluent.list_gateways- Full name
confluent.confluent_list_networking_v1_gateways
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_gateway Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create a gateway.
- Lua path
app.integrations.confluent.create_gateway- Full name
confluent.confluent_create_networking_v1_gateway
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_gateway Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read a gateway.
- Lua path
app.integrations.confluent.read_gateway- Full name
confluent.confluent_get_networking_v1_gateway
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_gateway Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update a gateway.
- Lua path
app.integrations.confluent.update_gateway- Full name
confluent.confluent_update_networking_v1_gateway
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_gateway Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete a gateway.
- Lua path
app.integrations.confluent.delete_gateway- Full name
confluent.confluent_delete_networking_v1_gateway
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_custom_code_loggings Read
!Early Accesshttps://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8section/Versioning/API-Lifecycle-Policy !Request Access To Custom Code Logging API EAhttps://img.shields.io/badge/-Request%20Access%20To%20Custom%20Code%20Logging%20API%20EA-%23bc8540mailto:ccloud-api-access+ccl-v1-early-access@confluent.io?subject=Request%20to%20join%20ccl/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20ccl/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E. Retrieve a sorted, filtered, paginated list of all custom code loggings.
- Lua path
app.integrations.confluent.list_custom_code_loggings- Full name
confluent.confluent_list_ccl_v1_custom_code_loggings
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_custom_code_logging Write
!Early Accesshttps://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8section/Versioning/API-Lifecycle-Policy !Request Access To Custom Code Logging API EAhttps://img.shields.io/badge/-Request%20Access%20To%20Custom%20Code%20Logging%20API%20EA-%23bc8540mailto:ccloud-api-access+ccl-v1-early-access@confluent.io?subject=Request%20to%20join%20ccl/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20ccl/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E. Make a request to create a custom code logging.
- Lua path
app.integrations.confluent.create_custom_code_logging- Full name
confluent.confluent_create_ccl_v1_custom_code_logging
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_custom_code_logging Read
!Early Accesshttps://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8section/Versioning/API-Lifecycle-Policy !Request Access To Custom Code Logging API EAhttps://img.shields.io/badge/-Request%20Access%20To%20Custom%20Code%20Logging%20API%20EA-%23bc8540mailto:ccloud-api-access+ccl-v1-early-access@confluent.io?subject=Request%20to%20join%20ccl/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20ccl/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E. Make a request to read a custom code logging.
- Lua path
app.integrations.confluent.read_custom_code_logging- Full name
confluent.confluent_get_ccl_v1_custom_code_logging
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_custom_code_logging Write
!Early Accesshttps://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8section/Versioning/API-Lifecycle-Policy !Request Access To Custom Code Logging API EAhttps://img.shields.io/badge/-Request%20Access%20To%20Custom%20Code%20Logging%20API%20EA-%23bc8540mailto:ccloud-api-access+ccl-v1-early-access@confluent.io?subject=Request%20to%20join%20ccl/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20ccl/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E. Make a request to update a custom code logging.
- Lua path
app.integrations.confluent.update_custom_code_logging- Full name
confluent.confluent_update_ccl_v1_custom_code_logging
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_custom_code_logging Write
!Early Accesshttps://img.shields.io/badge/Lifecycle%20Stage-Early%20Access-%2345c6e8section/Versioning/API-Lifecycle-Policy !Request Access To Custom Code Logging API EAhttps://img.shields.io/badge/-Request%20Access%20To%20Custom%20Code%20Logging%20API%20EA-%23bc8540mailto:ccloud-api-access+ccl-v1-early-access@confluent.io?subject=Request%20to%20join%20ccl/v1%20API%20Early%20Access&body=I%E2%80%99d%20like%20to%20join%20the%20Confluent%20Cloud%20API%20Early%20Access%20for%20ccl/v1%20to%20provide%20early%20feedback%21%20My%20Cloud%20Organization%20ID%20is%20%3Cretrieve%20from%20https%3A//confluent.cloud/settings/billing/payment%3E. Make a request to delete a custom code logging.
- Lua path
app.integrations.confluent.delete_custom_code_logging- Full name
confluent.confluent_delete_ccl_v1_custom_code_logging
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_regions Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all regions.
- Lua path
app.integrations.confluent.list_regions- Full name
confluent.confluent_list_tableflow_v1_regions
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_tableflow_topics Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all tableflow topics.
- Lua path
app.integrations.confluent.list_tableflow_topics- Full name
confluent.confluent_list_tableflow_v1_tableflow_topics
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_tableflow_topic Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create a tableflow topic.
- Lua path
app.integrations.confluent.create_tableflow_topic- Full name
confluent.confluent_create_tableflow_v1_tableflow_topic
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_tableflow_topic Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read a tableflow topic.
- Lua path
app.integrations.confluent.read_tableflow_topic- Full name
confluent.confluent_get_tableflow_v1_tableflow_topic
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_tableflow_topic Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update a tableflow topic.
- Lua path
app.integrations.confluent.update_tableflow_topic- Full name
confluent.confluent_update_tableflow_v1_tableflow_topic
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_tableflow_topic Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete a tableflow topic.
- Lua path
app.integrations.confluent.delete_tableflow_topic- Full name
confluent.confluent_delete_tableflow_v1_tableflow_topic
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_catalog_integrations Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all catalog integrations.
- Lua path
app.integrations.confluent.list_catalog_integrations- Full name
confluent.confluent_list_tableflow_v1_catalog_integrations
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_catalog_integration Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create a catalog integration.
- Lua path
app.integrations.confluent.create_catalog_integration- Full name
confluent.confluent_create_tableflow_v1_catalog_integration
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_catalog_integration Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read a catalog integration.
- Lua path
app.integrations.confluent.read_catalog_integration- Full name
confluent.confluent_get_tableflow_v1_catalog_integration
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_catalog_integration Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update a catalog integration.
- Lua path
app.integrations.confluent.update_catalog_integration- Full name
confluent.confluent_update_tableflow_v1_catalog_integration
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_catalog_integration Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete a catalog integration.
- Lua path
app.integrations.confluent.delete_catalog_integration- Full name
confluent.confluent_delete_tableflow_v1_catalog_integration
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_custom_connect_plugins Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all custom connect plugins. If no cloud filter is specified, returns custom connect plugins from all clouds.
- Lua path
app.integrations.confluent.list_custom_connect_plugins- Full name
confluent.confluent_list_ccpm_v1_custom_connect_plugins
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_custom_connect_plugin Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create a custom connect plugin.
- Lua path
app.integrations.confluent.create_custom_connect_plugin- Full name
confluent.confluent_create_ccpm_v1_custom_connect_plugin
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_custom_connect_plugin Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read a custom connect plugin.
- Lua path
app.integrations.confluent.read_custom_connect_plugin- Full name
confluent.confluent_get_ccpm_v1_custom_connect_plugin
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
update_custom_connect_plugin Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to update a custom connect plugin.
- Lua path
app.integrations.confluent.update_custom_connect_plugin- Full name
confluent.confluent_update_ccpm_v1_custom_connect_plugin
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_custom_connect_plugin Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete a custom connect plugin.
- Lua path
app.integrations.confluent.delete_custom_connect_plugin- Full name
confluent.confluent_delete_ccpm_v1_custom_connect_plugin
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
request_presigned_upload_url_new_custom_connect_plugin Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Request a presigned upload URL to upload a Custom Connect Plugin archive.
- Lua path
app.integrations.confluent.request_presigned_upload_url_new_custom_connect_plugin- Full name
confluent.confluent_create_ccpm_v1_presigned_url
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_custom_connect_plugin_versions Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all custom connect plugin versions.
- Lua path
app.integrations.confluent.list_custom_connect_plugin_versions- Full name
confluent.confluent_list_ccpm_v1_custom_connect_plugin_versions
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_custom_connect_plugin_version Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to create a custom connect plugin version.
- Lua path
app.integrations.confluent.create_custom_connect_plugin_version- Full name
confluent.confluent_create_ccpm_v1_custom_connect_plugin_version
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_custom_connect_plugin_version Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to read a custom connect plugin version.
- Lua path
app.integrations.confluent.read_custom_connect_plugin_version- Full name
confluent.confluent_get_ccpm_v1_custom_connect_plugin_version
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_custom_connect_plugin_version Write
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Make a request to delete a custom connect plugin version.
- Lua path
app.integrations.confluent.delete_custom_connect_plugin_version- Full name
confluent.confluent_delete_ccpm_v1_custom_connect_plugin_version
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_kafka_clusters Read
!Previewhttps://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afbasection/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all kafka clusters.
- Lua path
app.integrations.confluent.list_kafka_clusters- Full name
confluent.confluent_list_usm_v1_kafka_clusters
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_kafka_cluster Write
!Previewhttps://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afbasection/Versioning/API-Lifecycle-Policy Make a request to create a kafka cluster.
- Lua path
app.integrations.confluent.create_kafka_cluster- Full name
confluent.confluent_create_usm_v1_kafka_cluster
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_kafka_cluster Read
!Previewhttps://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afbasection/Versioning/API-Lifecycle-Policy Make a request to read a kafka cluster.
- Lua path
app.integrations.confluent.read_kafka_cluster- Full name
confluent.confluent_get_usm_v1_kafka_cluster
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_kafka_cluster Write
!Previewhttps://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afbasection/Versioning/API-Lifecycle-Policy Make a request to delete a kafka cluster.
- Lua path
app.integrations.confluent.delete_kafka_cluster- Full name
confluent.confluent_delete_usm_v1_kafka_cluster
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_connect_clusters Read
!Previewhttps://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afbasection/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all connect clusters.
- Lua path
app.integrations.confluent.list_connect_clusters- Full name
confluent.confluent_list_usm_v1_connect_clusters
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
create_connect_cluster Write
!Previewhttps://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afbasection/Versioning/API-Lifecycle-Policy Make a request to create a connect cluster.
- Lua path
app.integrations.confluent.create_connect_cluster- Full name
confluent.confluent_create_usm_v1_connect_cluster
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
read_connect_cluster Read
!Previewhttps://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afbasection/Versioning/API-Lifecycle-Policy Make a request to read a connect cluster.
- Lua path
app.integrations.confluent.read_connect_cluster- Full name
confluent.confluent_get_usm_v1_connect_cluster
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
delete_connect_cluster Write
!Previewhttps://img.shields.io/badge/Lifecycle%20Stage-Preview-%2300afbasection/Versioning/API-Lifecycle-Policy Make a request to delete a connect cluster.
- Lua path
app.integrations.confluent.delete_connect_cluster- Full name
confluent.confluent_delete_usm_v1_connect_cluster
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||
list_endpoints Read
!General Availabilityhttps://img.shields.io/badge/Lifecycle%20Stage-General%20Availability-%2345c6e8section/Versioning/API-Lifecycle-Policy Retrieve a sorted, filtered, paginated list of all endpoints.
- Lua path
app.integrations.confluent.list_endpoints- Full name
confluent.confluent_list_endpoint_v1_endpoints
| Parameter | Type | Required | Description |
|---|---|---|---|
| No parameters. | |||