openapi: 3.0.1 info: contact: email: support@aiven.io name: Aiven support team url: https://aiven.io/support-services title: Aiven API Documentation Account Service:_Kafka API version: v1 x-logo: altText: Aiven logo backgroundColor: '#fafafa' href: https://api.aiven.io/doc url: https://aiven.io/assets/img/aiven-logo.png description: "# Introduction\n\n[Direct link to openapi.json](https://api.aiven.io/doc/openapi.json) for use with external tools\n\n[Aiven](https://aiven.io) is a modern fully-managed open source data platform for streaming, storing, and analyzing data on any public cloud. On Aiven Platform, you can operate your data infrastructure with a few devops tools: [Aiven Console](https://console.aiven.io/), [Aiven Terraform Provider](https://aiven.io/docs/tools/terraform), [Aiven CLI](https://github.com/aiven/aiven-client), and [Aiven Operator for Kubernetes](https://github.com/aiven/aiven-operator). All of them are built on an open secure powerful REST API for integration with custom tooling.\n\nThe Aiven [REST](http://en.wikipedia.org/wiki/Representational_State_Transfer) API\nprovides programmatic access to Aiven.io services. To call the Aiven API, you can use either CLI tools (for example, `cURL` or [Aiven CLI client](https://aiven.io/docs/tools/cli)) or GUI tools, such as the [Aiven public API Postman collection](https://www.postman.com/aiven-apis).\n\nThis Aiven API documentation will help you operate your Aiven organization, projects, or services programmatically by integrating your applications and processes with Aiven.\n\n# Description\n\nAiven's APIs ([Application Programming Interfaces](https://en.wikipedia.org/wiki/API)) power its platform for data management. Aiven has a number of REST APIs that can help you build strong and robust data infrastructure for your applications.\n\nThe Aiven API is organized around core resources. Each core resource has multiple endpoints, which can be interacted with using different HTTP methods.\n\n## Core resources\n\n### Platform APIs\n\n

Account: Operations on the organization level related to accounts, projects, teams, users, invites, billing groups, payment methods, credit cards, authentication methods, and more
User: Operations related to users and users' profiles, access, authentication, authorization, user management, and more
Project: General operations on projects related to users, VPCs, invitations, alerts, peering connections, and more
BillingGroup: Operation on invoices, billing groups' credits and events
Support ticket: Operations on support tickets: listing, creating, looping users in

\n\n### Services APIs\n\n

Service: All general (non-service-specific) operations on the service level: service creation, termination, configuration, updates, information retrieval, reset, and more
Service Integrations: Operations related to integrating services and managing service integrations
Service: ClickHouse: ClickHouse-specific operations on queries and databases
Service: Flink: Operations on Flink queries, jobs, and applications
Service: Kafka: Kafka and Kafka Connect specific operations on connectors, ACL entries, quotas, topics, topic messages, schema registry, and more
Service: Kafka MirrorMaker: Operations on replication flows
Service: MySQL: Fetching service query statistics
Service: OpenSearch: Operations on ACL configuration, security administration and configuration
Service: PostgreSQL: Operations on extensions, service query statistics, and connection pools

\n\n# Requests\n\nThere are multiple ways you can interact with the Aiven API over HTTP. You can access it by sending requests from a client (for example, a web browser) to the Aiven's server. In this API reference, you'll find code examples of how to do that using `cURL` and a few different client libraries (programming languages).\n\nTo send an API request, you need to specify the following:\n\n* HTTP method\n* Path\n* Request headers\n\n Typically, `content-type` needs to be set to `application/json`: `content-type: application/json`. There are a few exceptions though.\n\n* Path, query, or body parameters (either required or optional).\n\n```bash\ncurl --request POST \\\n --url https://api.aiven.io/v1/project/{project}/vpcs \\\n --header 'Authorization: aivenv1 REPLACE_BEARER_TOKEN' \\\n --header 'content-type: application/json' \\\n --data\n '{\n \"cloud_name\": \"string\",\n \"network_cidr\": \"string\",\n \"peering_connections\": [\n {\n \"peer_azure_app_id\": \"string\",\n \"peer_azure_tenant_id\": \"string\",\n \"peer_cloud_account\": \"string\",\n \"peer_region\": \"string\",\n \"peer_resource_group\": \"string\",\n \"peer_vpc\": \"string\",\n \"user_peer_network_cidrs\": [\n \"string\"\n ]\n }\n ]\n }'\n```\n\n# Responses\n\nUpon receiving and processing a request, the Aiven API returns the response status code, response headers, and a response body in the `JSON` format. Response bodies include different properties, which can be either required or optional, for example, the ``message`` property, which is an optional human-readable information on the result of the action (deleted, created, or updated).\n\n```json\n{\n \"cloud_name\": \"string\",\n \"create_time\": \"string\",\n \"message\": \"string\",\n \"network_cidr\": \"string\",\n \"peering_connections\": [\n { ... }\n ],\n \"pending_build_only_peering_connections\": \"string\",\n \"project_vpc_id\": \"string\",\n \"state\": \"ACTIVE\",\n \"update_time\": \"string\"\n}\n```\n\n## Successful responses\n\nA successful API response returns an HTTP result code between 200 and 299.\n\nExample of the ``created`` response\n\n```json\n {\n \"service\": {\n \"service_name\": \"foobar\",\n ...\n }\n }\n```\n\n## Failed responses\n\nA failed API response returns a HTTP code greater or equal to 400. Additionally, the response may return a list of errors in the response body as JSON, for example\n\n```json\n{\n \"errors\": [\n {\n \"error_code\": \"authentication_failed\",\n \"message\": \"Authentication failed\",\n \"status\": 403,\n \"metadata\": {\n ...\n }\n }\n ],\n \"message\": \"Authentication failed\"\n}\n```\n\n> For information on errors' properties and error codes, check [Errors](/doc/openapi/openapi-description#errors).\n\n# Get started\n\nCheck out how to start using the Aiven API either in [API quick start](https://aiven.io/docs/tools/api#api-quickstart) or [Your first API call](https://aiven.io/blog/your-first-aiven-api-call).\n\n## Authentication\n\n\n\n# Errors\n\nWhen working with the Aiven API, you may encounter different error responses when you attempt to perform operations that can fail. For example, trying to enable writes for a database that has been powered off would lead to the following error response:\n\n```json\n{\n \"errors\": [\n {\n \"error_code\": \"not_powered\",\n \"message\": \"Database not powered on\",\n \"status\": 409\n }\n ],\n \"message\": \"Database not powered on\"\n}\n```\n\n## Check a response for errors\n\nIf a request fails with a HTTP code greater or equal to 400, it returns a list of errors in the response body as JSON. `errors` objects are embedded in the failed API responses.\n\n```json\n{\n \"errors\": [\n {\n \"error_code\": \"account_not_found\",\n \"message\": \"Account does not exist\",\n \"status\": 404\n }\n ],\n \"message\": \"Account does not exist\"\n}\n```\n\n## Errors' properties\n\nIn an API response, one or more errors may be included in the ``errors`` array of objects. Each error object may contain a few properties:\n\n* ``status`` (required) is an HTTP error code, which can be used to programmatically identify the error type.\n\n * ``200`` <= ``status``< ``300`` means a successful request.\n * ``300`` <= ``status`` <= ``500`` means a failed request.\n\n ``errors`` can have the following HTTPS status codes:\n\n * 200 - OK\n * 201 - Created\n * 400 - Bad Request\n * 401 - Unauthorized\n * 403 - Forbidden\n * 404 - Not found\n * 405 - Method Not Allowed\n * 409 - Conflict\n * 500 - Internal Server Error\n\n* ``message`` (required) is human-readable information on the error.\n* ``error_code`` is a machine-readable information on the error (see [Error codes](/doc/openapi/openapi-description#error-codes)).\n\n## Error codes\n\nMachine-readable ``error_code`` fields are progressively added to Aiven endpoints to allow you to identify different failure cases programmatically. Currently, the supported values are the following:\n\n- `account_already_exists`\n- `account_already_has_organization`\n- `account_and_project_do_not_match`\n- `account_and_project_must_belong_same_tenant`\n- `account_cannot_be_own_ancestor`\n- `account_must_have_enabled_authentication_method`\n- `account_not_found`\n- `account_team_not_found`\n- `account_unit_cannot_create_for_personal_tier`\n- `account_unit_cannot_have_billing_group`\n- `account_with_child_accounts_cannot_be_deleted`\n- `account_with_projects_cannot_be_deleted`\n- `action_forbidden_for_application_users`\n- `action_forbidden_for_managed_users`\n- `action_forbidden_for_marketplace_users`\n- `action_forbidden_for_scim_users`\n- `action_forbidden_for_timescale_users`\n- `action_forbidden_missing_governance_usergroup`\n- `action_forbidden_on_application_users`\n- `action_forbidden_on_topic_request`\n- `action_forbidden_on_unmanaged_users`\n- `acu_billing_not_allowed`\n- `address_already_belongs_to_organization`\n- `address_in_use`\n- `address_not_found`\n- `api_client_ip_allowlist_blocks_caller`\n- `approval_forbidden_on_topic_request`\n- `approval_missing_on_request`\n- `auth_token_max_age_too_low`\n- `authentication_method_disable_current_not_allowed`\n- `authentication_method_does_not_allow_auto_join_user_group`\n- `authentication_method_limit_reached`\n- `authentication_method_not_found`\n- `backup_failed`\n- `bad_request`\n- `billing_address_not_found`\n- `billing_customer_id_not_found`\n- `billing_group_not_found`\n- `billing_group_organization_active_trial`\n- `billing_group_owning_account_must_be_organization`\n- `billing_metronome_support_contract_not_found`\n- `ca_version_not_in_sequence`\n- `cannot_delete_active_managed_users`\n- `cannot_delete_users_with_organizations_memberships`\n- `cannot_move_project_not_assigned_to_organization`\n- `cannot_remove_managed_users_from_organization`\n- `cannot_set_groups_managed_by_scim_as_auto_join_group`\n- `client_ip_address_policy_violation`\n- `credit_card_not_found`\n- `credit_memo_not_found`\n- `custom_cloud_environment_cloud_not_supported`\n- `custom_cloud_environment_internal`\n- `custom_cloud_environment_invalid_iam_role_arn`\n- `custom_cloud_environment_missing_configuration`\n- `custom_cloud_environment_not_found`\n- `custom_cloud_environment_region_not_supported`\n- `database_not_found`\n- `decline_forbidden_on_topic_request`\n- `deleting_forbidden_on_governance_request`\n- `deleting_forbidden_on_topic_request`\n- `discount_not_found`\n- `feature_not_enabled`\n- `free_plans_in_high_demand_and_unavailable`\n- `free_tier_restricted`\n- `free_trial_extensions_not_available`\n- `free_trial_max_extended`\n- `free_trial_not_active`\n- `free_trial_not_available`\n- `governance_access_no_permission_on_project`\n- `governance_access_not_found`\n- `governance_configuration_already_exists`\n- `governance_configuration_not_found`\n- `governance_group_not_found`\n- `governance_invalid_service_type`\n- `governance_request_already_in_progress`\n- `governance_request_deleted`\n- `idp_no_domains_linked`\n- `index_close_failed`\n- `index_not_found`\n- `internal_server_error`\n- `invalid_backup_configuration`\n- `invalid_cmk_id`\n- `invalid_currency_code`\n- `invalid_date_format`\n- `invalid_email_format`\n- `invalid_governance_group_provided`\n- `invalid_kafka_topic_request_type`\n- `invalid_os_migration_command`\n- `invalid_owner_user_group`\n- `invalid_private_access_settings`\n- `invalid_scim_user_state_update`\n- `invalid_service_type`\n- `invalid_vcs_type`\n- `invitation_expired`\n- `invitation_not_found`\n- `invoice_lines_not_supported`\n- `invoice_not_found`\n- `ip_address_not_present`\n- `ip_address_not_valid`\n- `kafka_acl_not_supported`\n- `kafka_console_governance_enabled`\n- `kafka_governance_not_available`\n- `kafka_governance_not_enabled`\n- `kafka_governance_policy_incomplete`\n- `kafka_partition_reassignment_in_progress`\n- `kafka_policy_violation`\n- `kafka_service_unavailable`\n- `kafka_terraform_governance_enabled`\n- `kafka_topic_already_exists`\n- `kafka_topic_invalid_config`\n- `kafka_topic_not_found`\n- `kafka_topic_not_synchronized`\n- `kafka_topic_queued_for_deletion`\n- `kafka_topic_reserved`\n- `marketplace_aws_customer_or_product_details_not_found`\n- `marketplace_subscription_already_linked_to_organization`\n- `marketplace_subscription_link_expired`\n- `marketplace_subscription_no_access`\n- `metadata_validation_failed`\n- `mfa_required_by_organization`\n- `mp_account_with_active_subscription_deleted`\n- `mp_account_with_commitment_deleted`\n- `mp_account_with_support_contract_deleted`\n- `mp_subscription_not_found`\n- `nested_account_cannot_have_authentication_method`\n- `nested_account_cannot_have_user_groups`\n- `new_subnet_id_required`\n- `no_failed_os_migration`\n- `node_prune_version_not_updated`\n- `not_powered`\n- `opensearch_delete_system_index`\n- `opensearch_internal_server_error`\n- `opensearch_service_unavailable`\n- `opensearch_too_many_requests`\n- `optimization_failed`\n- `optimization_not_found`\n- `organization_aiven_enterprise_contract_denied`\n- `organization_aiven_enterprise_contract_feature_denied`\n- `organization_aiven_enterprise_denied`\n- `organization_aiven_enterprise_organization_required`\n- `organization_cannot_exist_without_root_account`\n- `organization_domain_already_linked`\n- `organization_domain_not_found`\n- `organization_domain_not_root`\n- `organization_domain_verification_failed`\n- `organization_has_active_addresses`\n- `organization_has_active_payment_methods`\n- `organization_kafka_topics_invalid_filters`\n- `organization_mismatch`\n- `organization_must_have_one_super_admin`\n- `organization_not_found`\n- `organization_pending_support_contract_already_exists`\n- `organization_support_contract_tier_not_supported`\n- `organization_tier_downgrade_not_allowed`\n- `organization_user_not_found`\n- `orphaned_project_not_allowed`\n- `parent_account_cannot_be_own_ancestor`\n- `parent_account_not_found`\n- `parent_account_tenant_invalid`\n- `parent_account_too_deep`\n- `payment_method_not_found`\n- `permission_denied`\n- `pg_editor_readonly_violation`\n- `pg_pool_already_exists`\n- `pg_pool_invalid_database`\n- `pg_pool_invalid_name`\n- `pg_pool_not_found`\n- `pg_pool_not_supported`\n- `pg_pool_pinned_pools_not_enabled`\n- `pg_pool_requires_pinned_pools`\n- `pg_pool_too_big`\n- `pg_pool_too_many`\n- `pg_publication_not_found`\n- `pg_replication_slot_not_found`\n- `pg_scram_not_allowed`\n- `project_account_not_active`\n- `project_already_exists`\n- `project_belongs_to_account_billing_group_must_use_api`\n- `project_does_not_exist`\n- `project_has_no_such_user`\n- `project_limitation_not_found`\n- `project_move_invalid`\n- `project_move_organizations_internal_config_not_match`\n- `project_not_found`\n- `project_without_billing_group_must_be_assigned_from_account`\n- `query_validation_failed`\n- `replication_already_exists`\n- `replication_config_invalid`\n- `replication_not_found`\n- `replication_service_not_found`\n- `repository_not_found`\n- `request_already_exists`\n- `request_forbidden`\n- `request_not_found`\n- `request_operation_already_exists`\n- `request_operation_not_found`\n- `resource_managed_by_governance`\n- `resource_managed_by_scim`\n- `resource_not_managed_by_scim`\n- `retired_api_endpoint`\n- `root_account_required`\n- `same_organization_required`\n- `schema_insights_failed`\n- `service_acl_not_found`\n- `service_acl_too_many`\n- `service_does_not_exist`\n- `service_governance_not_enabled`\n- `service_integration_endpoint_not_found`\n- `service_integration_not_found`\n- `service_integration_project_mismatch_source_destination`\n- `service_is_upgrade_pipeline_source`\n- `service_logs_backend_timeout`\n- `service_logs_backend_unavailable`\n- `service_maintenance_required`\n- `service_not_found`\n- `service_type_not_allowed`\n- `service_type_version_pin_locked`\n- `shipping_address_not_found`\n- `signup_welcome_invalid_key`\n- `snapshot_creation_failed`\n- `snapshot_deletion_failed`\n- `snapshot_not_found`\n- `snapshot_restoration_failed`\n- `stripe_customer_owning_account_must_be_organization`\n- `support_contract_and_account_must_be_in_same_organization`\n- `support_contract_earliest_cancellation_date_later_than_end_date`\n- `support_contract_must_have_billing_group`\n- `support_contract_null_tier`\n- `team_limit_exceeded`\n- `team_names_must_be_unique`\n- `tenant_mismatch`\n- `topic_not_found`\n- `unable_to_parse_query`\n- `unit_cannot_be_moved_out_of_organization`\n- `unknown_user_sso_login_attempt`\n- `unsupported_resource_type`\n- `upgrade_pipeline_no_nodes`\n- `upgrade_pipeline_no_validation`\n- `upgrade_pipeline_not_enabled_for_project`\n- `upgrade_pipeline_service_not_destination`\n- `upgrade_pipeline_service_not_found`\n- `upgrade_step_destination_already_has_source`\n- `upgrade_step_destination_service_not_found`\n- `upgrade_step_exceeds_max_chain_length`\n- `upgrade_step_not_found`\n- `upgrade_step_service_type_mismatch`\n- `upgrade_step_source_service_not_found`\n- `upgrade_step_unsupported_service_type`\n- `upgrade_step_validation_not_possible_due_to_service_state`\n- `upgrade_step_would_create_cycle`\n- `upgrade_validation_already_exists`\n- `user_already_in_organization`\n- `user_already_invited_to_organization`\n- `user_cant_login`\n- `user_config_2fa_otp_verification_failed`\n- `user_deactivated`\n- `user_domain_does_not_belong_to_organization_or_no_linked_auth_method`\n- `user_group_names_must_be_unique`\n- `user_group_not_found`\n- `user_groups_belong_to_different_accounts`\n- `user_groups_must_be_from_same_account`\n- `user_has_no_access_to_billing_info`\n- `user_has_no_access_to_project_with_current_authentication_method`\n- `user_has_to_sign_in_with_non_account_authentication_method`\n- `user_has_too_many_disk_addition_requests`\n- `user_is_internal_user`\n- `user_not_account_owner`\n- `user_not_account_owner_of_billing_group`\n- `user_not_account_owner_of_parent_account`\n- `user_not_admin_of_account_billing_group`\n- `user_not_application_user`\n- `user_not_found`\n- `user_not_managed_by_organization`\n- `user_not_organization_admin`\n- `user_not_signed_in_with_account_authentication_method`\n- `user_oauth_authentication_method_not_allowed`\n- `user_password_authentication_method_not_allowed`\n- `user_password_compromised`\n- `user_password_not_found`\n- `user_personal_token_allowed_authentication_methods_cannot_be_disabled`\n- `user_personal_token_not_allowed`\n- `user_personal_tokens_cannot_be_disabled`\n- `user_role_not_allowed_to_perform_operation`\n- `user_saml_authentication_method_not_allowed`\n- `user_weblink_action_expired`\n- `username_is_invalid`\n- `username_is_reserved`\n- `users_belong_to_different_tenant_from_user_group_account`\n- `vcs_integration_installation_not_found_or_not_accessible`\n- `vcs_integration_not_found`\n- `vpc_id_and_subnet_id_required`\n- `webhook_invalid_event_data`\n- `webhook_unauthorized`\n" servers: - url: https://api.aiven.io/v1 tags: - name: Service:_Kafka x-displayName: 'Service: Kafka' paths: /project/{project}/service/{service_name}/acl: post: summary: Add Aiven Kafka ACL entry tags: - Service:_Kafka operationId: ServiceKafkaAclAdd parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceKafkaAclAddRequestBody' example: permission: readwrite topic: top* username: admin* responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceKafkaAclAddResponse' '400': description: Invalid request parameters content: application/json: schema: type: object properties: message: type: string title: Human readable error message errors: type: array title: List of error details. Typically there is only one element items: type: object properties: message: type: string title: Human readable error message error_code: type: string enum: - service_acl_too_many title: Machine processable error code. Clients must be prepared to handle new codes. description: 'service_acl_too_many: Maximum number of service ACLs reached' security: - tokenAuth: [] oauth2: - services:write get: summary: List Aiven ACL entries for Kafka service tags: - Service:_Kafka operationId: ServiceKafkaAclList parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceKafkaAclListResponse' '404': description: Resource not found content: application/json: schema: type: object properties: message: type: string title: Human readable error message errors: type: array title: List of error details. Typically there is only one element items: type: object properties: message: type: string title: Human readable error message error_code: type: string enum: - service_not_found title: Machine processable error code. Clients must be prepared to handle new codes. description: 'service_not_found: Service not found' security: - tokenAuth: [] oauth2: - services:read /project/{project}/service/{service_name}/acl/{kafka_acl_id}: delete: summary: Delete a Kafka ACL entry tags: - Service:_Kafka operationId: ServiceKafkaAclDelete parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' - $ref: '#/components/parameters/kafka_acl_id' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceKafkaAclDeleteResponse' '404': description: Resource not found content: application/json: schema: type: object properties: message: type: string title: Human readable error message errors: type: array title: List of error details. Typically there is only one element items: type: object properties: message: type: string title: Human readable error message error_code: type: string enum: - service_acl_not_found title: Machine processable error code. Clients must be prepared to handle new codes. description: 'service_acl_not_found: No such service ACL exists' security: - tokenAuth: [] oauth2: - services:write /project/{project}/service/{service_name}/connectors: post: summary: Create a Kafka Connect connector tags: - Service:_Kafka operationId: ServiceKafkaConnectCreateConnector parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceKafkaConnectCreateConnectorRequestBody' example: connector\.class: io.debezium.connector.postgresql.PostgresConnector name: s3-sink-us-east-1 responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceKafkaConnectCreateConnectorResponse' security: - tokenAuth: [] oauth2: - services:write get: summary: Lists Kafka connectors tags: - Service:_Kafka operationId: ServiceKafkaConnectList description:

Returns successfully resolved connectors in 'connectors' array. If any connectors fail plugin resolution, they are returned in 'failed_connectors' array with an 'error' field explaining the issue.

Return "400 Bad Request" if tiered storage feature is not enabled for this service. Rarely, the data may be not available. In this case, "503 Service Unavailable" is returned and the client should try later.

parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceKafkaTieredStorageStorageUsageTotalResponse' security: - tokenAuth: [] oauth2: - services:read /project/{project}/service/{service_name}/kafka/tiered-storage/summary: get: summary: Get the Kafka tiered storage summary tags: - Service:_Kafka operationId: ServiceKafkaTieredStorageSummary parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceKafkaTieredStorageSummaryResponse' security: - tokenAuth: [] oauth2: - services:read /project/{project}/service/{service_name}/topic: post: summary: Create a Kafka topic tags: - Service:_Kafka operationId: ServiceKafkaTopicCreate parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceKafkaTopicCreateRequestBody' example: cleanup_policy: delete config: cleanup_policy: delete compression_type: zstd delete_retention_ms: 0 diskless_enable: false file_delete_delay_ms: 0 flush_messages: 0 flush_ms: 0 index_interval_bytes: 0 local_retention_bytes: -2 local_retention_ms: -2 max_compaction_lag_ms: 0 max_message_bytes: 0 message_downconversion_enable: true message_format_version: 2.7-IV2 message_timestamp_after_max_ms: 0 message_timestamp_before_max_ms: 0 message_timestamp_difference_max_ms: 0 message_timestamp_type: CreateTime min_cleanable_dirty_ratio: 0.5 min_compaction_lag_ms: 0 min_insync_replicas: 2 preallocate: false remote_storage_enable: false retention_bytes: -1 retention_ms: 604800000 segment_bytes: 1073741824 segment_index_bytes: 0 segment_jitter_ms: 0 segment_ms: 1 unclean_leader_election_enable: false min_insync_replicas: 2 owner_user_group_id: ug22ba494e096 partitions: 1 replication: 2 retention_bytes: -1 retention_hours: 72 tags: - key: My-tag_key value: My tag value, value. topic_description: Platform events topic_name: mytopic responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceKafkaTopicCreateResponse' '400': description: Invalid request parameters content: application/json: schema: type: object properties: message: type: string title: Human readable error message errors: type: array title: List of error details. Typically there is only one element items: type: object properties: message: type: string title: Human readable error message error_code: type: string enum: - kafka_topic_invalid_config title: Machine processable error code. Clients must be prepared to handle new codes. description: 'kafka_topic_invalid_config: Topic configuration either invalid or conflicting with kafka setup' '409': description: Request conflict content: application/json: schema: type: object properties: message: type: string title: Human readable error message errors: type: array title: List of error details. Typically there is only one element items: type: object properties: message: type: string title: Human readable error message error_code: type: string enum: - kafka_topic_already_exists title: Machine processable error code. Clients must be prepared to handle new codes. description: 'kafka_topic_already_exists: Topic already exists and cannot be created' '503': description: The server cannot process the request due to a high load content: application/json: schema: type: object properties: message: type: string title: Human readable error message errors: type: array title: List of error details. Typically there is only one element items: type: object properties: message: type: string title: Human readable error message error_code: type: string enum: - kafka_service_unavailable title: Machine processable error code. Clients must be prepared to handle new codes. description: 'kafka_service_unavailable: Kafka service is currently unavailable' security: - tokenAuth: [] oauth2: - services:write get: summary: Get Kafka topic list tags: - Service:_Kafka operationId: ServiceKafkaTopicList parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceKafkaTopicListResponse' security: - tokenAuth: [] oauth2: - services:read /project/{project}/service/{service_name}/topic/{topic_name}: delete: summary: Delete a Kafka topic tags: - Service:_Kafka operationId: ServiceKafkaTopicDelete parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' - $ref: '#/components/parameters/topic_name' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceKafkaTopicDeleteResponse' '404': description: Resource not found content: application/json: schema: type: object properties: message: type: string title: Human readable error message errors: type: array title: List of error details. Typically there is only one element items: type: object properties: message: type: string title: Human readable error message error_code: type: string enum: - kafka_topic_not_found title: Machine processable error code. Clients must be prepared to handle new codes. description: 'kafka_topic_not_found: No such topic exists' '409': description: Request conflict content: application/json: schema: type: object properties: message: type: string title: Human readable error message errors: type: array title: List of error details. Typically there is only one element items: type: object properties: message: type: string title: Human readable error message error_code: type: string enum: - kafka_topic_reserved title: Machine processable error code. Clients must be prepared to handle new codes. description: 'kafka_topic_reserved: Topic is reserved for internal use' '503': description: The server cannot process the request due to a high load content: application/json: schema: type: object properties: message: type: string title: Human readable error message errors: type: array title: List of error details. Typically there is only one element items: type: object properties: message: type: string title: Human readable error message error_code: type: string enum: - kafka_service_unavailable title: Machine processable error code. Clients must be prepared to handle new codes. description: 'kafka_service_unavailable: Kafka service is currently unavailable' security: - tokenAuth: [] oauth2: - services:write get: summary: Get Kafka topic info tags: - Service:_Kafka operationId: ServiceKafkaTopicGet parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' - $ref: '#/components/parameters/topic_name' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceKafkaTopicGetResponse' '404': description: Resource not found content: application/json: schema: type: object properties: message: type: string title: Human readable error message errors: type: array title: List of error details. Typically there is only one element items: type: object properties: message: type: string title: Human readable error message error_code: type: string enum: - kafka_topic_not_found title: Machine processable error code. Clients must be prepared to handle new codes. description: 'kafka_topic_not_found: No such topic exists' '409': description: Request conflict content: application/json: schema: type: object properties: message: type: string title: Human readable error message errors: type: array title: List of error details. Typically there is only one element items: type: object properties: message: type: string title: Human readable error message error_code: type: string enum: - kafka_topic_not_synchronized title: Machine processable error code. Clients must be prepared to handle new codes. description: 'kafka_topic_not_synchronized: Topic state is not synchronized' security: - tokenAuth: [] oauth2: - services:read put: summary: Update a Kafka topic tags: - Service:_Kafka operationId: ServiceKafkaTopicUpdate parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' - $ref: '#/components/parameters/topic_name' requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceKafkaTopicUpdateRequestBody' example: config: cleanup_policy: delete compression_type: zstd delete_retention_ms: 0 diskless_enable: false file_delete_delay_ms: 0 flush_messages: 0 flush_ms: 0 index_interval_bytes: 0 local_retention_bytes: -2 local_retention_ms: -2 max_compaction_lag_ms: 0 max_message_bytes: 0 message_downconversion_enable: true message_format_version: 2.7-IV2 message_timestamp_after_max_ms: 0 message_timestamp_before_max_ms: 0 message_timestamp_difference_max_ms: 0 message_timestamp_type: CreateTime min_cleanable_dirty_ratio: 0.5 min_compaction_lag_ms: 0 min_insync_replicas: 2 preallocate: false remote_storage_enable: false retention_bytes: -1 retention_ms: 604800000 segment_bytes: 1073741824 segment_index_bytes: 0 segment_jitter_ms: 0 segment_ms: 1 unclean_leader_election_enable: false min_insync_replicas: 2 owner_user_group_id: ug22ba494e096 partitions: 1 replication: 2 retention_bytes: -1 retention_hours: 72 tags: - key: My-tag_key value: My tag value, value. topic_description: Platform events responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceKafkaTopicUpdateResponse' '400': description: Invalid request parameters content: application/json: schema: type: object properties: message: type: string title: Human readable error message errors: type: array title: List of error details. Typically there is only one element items: type: object properties: message: type: string title: Human readable error message error_code: type: string enum: - kafka_topic_invalid_config title: Machine processable error code. Clients must be prepared to handle new codes. description: 'kafka_topic_invalid_config: Topic configuration either invalid or conflicting with kafka setup' '404': description: Resource not found content: application/json: schema: type: object properties: message: type: string title: Human readable error message errors: type: array title: List of error details. Typically there is only one element items: type: object properties: message: type: string title: Human readable error message error_code: type: string enum: - kafka_topic_not_found title: Machine processable error code. Clients must be prepared to handle new codes. description: 'kafka_topic_not_found: No such topic exists' '409': description: Request conflict content: application/json: schema: type: object properties: message: type: string title: Human readable error message errors: type: array title: List of error details. Typically there is only one element items: type: object properties: message: type: string title: Human readable error message error_code: type: string enum: - kafka_partition_reassignment_in_progress title: Machine processable error code. Clients must be prepared to handle new codes. description: 'kafka_partition_reassignment_in_progress: Unable to update partitions during partition reassignment' '503': description: The server cannot process the request due to a high load content: application/json: schema: type: object properties: message: type: string title: Human readable error message errors: type: array title: List of error details. Typically there is only one element items: type: object properties: message: type: string title: Human readable error message error_code: type: string enum: - kafka_service_unavailable title: Machine processable error code. Clients must be prepared to handle new codes. description: 'kafka_service_unavailable: Kafka service is currently unavailable' security: - tokenAuth: [] oauth2: - services:write /project/{project}/service/{service_name}/kafka/rest/topics/{topic_name}/messages: post: summary: List kafka topic messages tags: - Service:_Kafka operationId: ServiceKafkaTopicMessageList parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' - $ref: '#/components/parameters/topic_name' requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceKafkaTopicMessageListRequestBody' example: format: json max_bytes: 67108864 partitions: {} timeout: 3000 responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceKafkaTopicMessageListResponse' security: - tokenAuth: [] oauth2: - services:read /project/{project}/service/{service_name}/kafka/rest/topics/{topic_name}/produce: post: summary: Produce message into a kafka topic tags: - Service:_Kafka operationId: ServiceKafkaTopicMessageProduce parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' - $ref: '#/components/parameters/topic_name' requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceKafkaTopicMessageProduceRequestBody' example: format: binary key_schema: '{\"name\": \"int\", \"type\": \"int\"}' key_schema_id: 123 records: - key: {} partition: 1 value: {} value_schema: '{\"name\": \"int\", \"type\": \"int\"}' value_schema_id: 123 responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceKafkaTopicMessageProduceResponse' security: - tokenAuth: [] oauth2: - services:write /project/{project}/service/{service_name}/kafka/schema-registry/acl: post: summary: Add a Schema Registry ACL entry tags: - Service:_Kafka operationId: ServiceSchemaRegistryAclAdd parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceSchemaRegistryAclAddRequestBody' example: permission: schema_registry_read resource: 'Config:' username: admin* responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceSchemaRegistryAclAddResponse' '400': description: Invalid request parameters content: application/json: schema: type: object properties: message: type: string title: Human readable error message errors: type: array title: List of error details. Typically there is only one element items: type: object properties: message: type: string title: Human readable error message error_code: type: string enum: - service_acl_too_many title: Machine processable error code. Clients must be prepared to handle new codes. description: 'service_acl_too_many: Maximum number of service ACLs reached' security: - tokenAuth: [] oauth2: - services:write get: summary: List Schema Registry ACL entries tags: - Service:_Kafka operationId: ServiceSchemaRegistryAclList parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceSchemaRegistryAclListResponse' security: - tokenAuth: [] oauth2: - services:read /project/{project}/service/{service_name}/kafka/schema-registry/acl/{schema_registry_acl_id}: delete: summary: Delete a Schema Registry ACL entry tags: - Service:_Kafka operationId: ServiceSchemaRegistryAclDelete parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' - $ref: '#/components/parameters/schema_registry_acl_id' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceSchemaRegistryAclDeleteResponse' security: - tokenAuth: [] oauth2: - services:write /project/{project}/service/{service_name}/kafka/schema/compatibility/subjects/{subject_name}/versions/{version_id}: post: summary: Check compatibility of schema in Schema Registry tags: - Service:_Kafka operationId: ServiceSchemaRegistryCompatibility parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' - $ref: '#/components/parameters/subject_name' - $ref: '#/components/parameters/version_id' requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceSchemaRegistryCompatibilityRequestBody' example: schema: '{"type": "string"}' schemaType: AVRO responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceSchemaRegistryCompatibilityResponse' security: - tokenAuth: [] oauth2: - services:read /project/{project}/service/{service_name}/kafka/schema/config: get: summary: Get global configuration for Schema Registry tags: - Service:_Kafka operationId: ServiceSchemaRegistryGlobalConfigGet parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceSchemaRegistryGlobalConfigGetResponse' security: - tokenAuth: [] oauth2: - services:read put: summary: Edit global configuration for Schema Registry tags: - Service:_Kafka operationId: ServiceSchemaRegistryGlobalConfigPut parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceSchemaRegistryGlobalConfigPutRequestBody' example: compatibility: FULL responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceSchemaRegistryGlobalConfigPutResponse' security: - tokenAuth: [] oauth2: - services:write /project/{project}/service/{service_name}/kafka/schema/schemas/ids/{schema_id}: get: summary: Get schema in Schema Registry tags: - Service:_Kafka operationId: ServiceSchemaRegistrySchemaGet parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' - $ref: '#/components/parameters/schema_id' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceSchemaRegistrySchemaGetResponse' security: - tokenAuth: [] oauth2: - services:read /project/{project}/service/{service_name}/kafka/schema/config/{subject_name}: get: summary: Get configuration for Schema Registry subject tags: - Service:_Kafka operationId: ServiceSchemaRegistrySubjectConfigGet parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' - $ref: '#/components/parameters/subject_name' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceSchemaRegistrySubjectConfigGetResponse' security: - tokenAuth: [] oauth2: - services:read put: summary: Edit configuration for Schema Registry subject tags: - Service:_Kafka operationId: ServiceSchemaRegistrySubjectConfigPut parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' - $ref: '#/components/parameters/subject_name' requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceSchemaRegistrySubjectConfigPutRequestBody' example: compatibility: FULL responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceSchemaRegistrySubjectConfigPutResponse' security: - tokenAuth: [] oauth2: - services:write /project/{project}/service/{service_name}/kafka/schema/subjects/{subject_name}: delete: summary: Delete Schema Registry subject tags: - Service:_Kafka operationId: ServiceSchemaRegistrySubjectDelete parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' - $ref: '#/components/parameters/subject_name' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceSchemaRegistrySubjectDeleteResponse' security: - tokenAuth: [] oauth2: - services:write /project/{project}/service/{service_name}/kafka/schema/subjects/{subject_name}/versions/{version_id}: delete: summary: Delete Schema Registry subject version tags: - Service:_Kafka operationId: ServiceSchemaRegistrySubjectVersionDelete parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' - $ref: '#/components/parameters/subject_name' - $ref: '#/components/parameters/version_id' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceSchemaRegistrySubjectVersionDeleteResponse' security: - tokenAuth: [] oauth2: - services:write get: summary: Get Schema Registry Subject version tags: - Service:_Kafka operationId: ServiceSchemaRegistrySubjectVersionGet parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' - $ref: '#/components/parameters/subject_name' - $ref: '#/components/parameters/version_id' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceSchemaRegistrySubjectVersionGetResponse' security: - tokenAuth: [] oauth2: - services:read /project/{project}/service/{service_name}/kafka/schema/subjects/{subject_name}/versions: post: summary: Register a new Schema in Schema Registry tags: - Service:_Kafka operationId: ServiceSchemaRegistrySubjectVersionPost parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' - $ref: '#/components/parameters/subject_name' requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceSchemaRegistrySubjectVersionPostRequestBody' example: references: - name: container1.proto subject: topic1-values version: 1 schema: '{"type": "string"}' schemaType: AVRO responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceSchemaRegistrySubjectVersionPostResponse' security: - tokenAuth: [] oauth2: - services:write get: summary: Get Schema Registry subject versions tags: - Service:_Kafka operationId: ServiceSchemaRegistrySubjectVersionsGet parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' - $ref: '#/components/parameters/subject_name' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceSchemaRegistrySubjectVersionsGetResponse' security: - tokenAuth: [] oauth2: - services:read /project/{project}/service/{service_name}/kafka/schema/subjects/{subject_name}/versions/{version_id}/schema: get: summary: 'DEPRECATED: Get raw schema of a specific version in Schema Registry' tags: - Service:_Kafka operationId: ServiceSchemaRegistrySubjectVersionSchemaGet deprecated: true parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' - $ref: '#/components/parameters/subject_name' - $ref: '#/components/parameters/version_id' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceSchemaRegistrySubjectVersionSchemaGetResponse' security: - tokenAuth: [] oauth2: - services:read /project/{project}/service/{service_name}/kafka/schema/subjects: get: summary: Lists Schema Registry subjects tags: - Service:_Kafka operationId: ServiceSchemaRegistrySubjects parameters: - $ref: '#/components/parameters/project' - $ref: '#/components/parameters/service_name' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/ServiceSchemaRegistrySubjectsResponse' security: - tokenAuth: [] oauth2: - services:read components: schemas: ServiceSchemaRegistryCompatibilityResponse: type: object description: ServiceSchemaRegistryCompatibilityResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status is_compatible: type: boolean description: Compatibility message: type: string description: Printable result of the request messages: type: array maxItems: 128 description: Compatibility check messages items: type: string required: - is_compatible ServiceSchemaRegistryAclDeleteResponse: type: object description: ServiceSchemaRegistryAclDeleteResponse properties: acl: type: array description: List of Schema Registry ACL entries items: type: object properties: id: type: string maxLength: 40 description: ID permission: type: string description: ACL entry for Schema Registry enum: - schema_registry_read - schema_registry_write resource: type: string minLength: 1 maxLength: 249 description: Schema Registry ACL entry resource name pattern username: type: string minLength: 1 maxLength: 64 description: Username required: - permission - resource - username errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request required: - acl ServiceSchemaRegistrySubjectDeleteResponse: type: object description: ServiceSchemaRegistrySubjectDeleteResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request ServiceKafkaTopicUpdateResponse: type: object description: ServiceKafkaTopicUpdateResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request ServiceSchemaRegistrySubjectVersionDeleteResponse: type: object description: ServiceSchemaRegistrySubjectVersionDeleteResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request ServiceKafkaQuotaCreateRequestBody: type: object description: ServiceKafkaQuotaCreateRequestBody properties: client\-id: type: string maxLength: 255 description: Represents a logical group of clients, assigned a unique name by the client application. Quotas can be applied based on user, client-id, or both. The most relevant quota is chosen for each connection. All connections within a quota group share the same quota. title: client-id consumer_byte_rate: type: number minimum: 0 maximum: 1073741824 description: Defines the bandwidth limit in bytes/sec for each group of clients sharing a quota. Every distinct client group is allocated a specific quota, as defined by the cluster, on a per-broker basis. Exceeding this limit results in client throttling. title: consumer network throttle producer_byte_rate: type: number minimum: 0 maximum: 1073741824 description: Defines the bandwidth limit in bytes/sec for each group of clients sharing a quota. Every distinct client group is allocated a specific quota, as defined by the cluster, on a per-broker basis. Exceeding this limit results in client throttling. title: producer network throttle request_percentage: type: number minimum: 0 maximum: 100 description: Sets the maximum percentage of CPU time that a client group can use on request handler I/O and network threads per broker within a quota window. Exceeding this limit triggers throttling. The quota, expressed as a percentage, also indicates the total allowable CPU usage for the client groups sharing the quota. title: cpu percentage throttle user: type: string maxLength: 64 description: Represents a logical group of clients, assigned a unique name by the client application. Quotas can be applied based on user, client-id, or both. The most relevant quota is chosen for each connection. All connections within a quota group share the same quota. title: user ServiceKafkaTopicUpdateRequestBody: type: object description: ServiceKafkaTopicUpdateRequestBody properties: config: type: object description: Kafka topic configuration properties: cleanup_policy: type: string description: The retention policy to use on old segments. Possible values include 'delete', 'compact', or a comma-separated list of them. The default policy ('delete') will discard old segments when their retention time or size limit has been reached. The 'compact' setting will enable log compaction on the topic. title: cleanup.policy enum: - delete - compact - compact,delete compression_type: type: string description: Specify the final compression type for a given topic. This configuration accepts the standard compression codecs ('gzip', 'snappy', 'lz4', 'zstd'). It additionally accepts 'uncompressed' which is equivalent to no compression; and 'producer' which means retain the original compression codec set by the producer. title: compression.type enum: - snappy - gzip - lz4 - producer - uncompressed - zstd delete_retention_ms: type: integer minimum: 0 description: The amount of time to retain delete tombstone markers for log compacted topics. This setting also gives a bound on the time in which a consumer must complete a read if they begin from offset 0 to ensure that they get a valid snapshot of the final stage (otherwise delete tombstones may be collected before they complete their scan). title: delete.retention.ms diskless_enable: type: boolean description: Indicates whether diskless should be enabled. This is only available for BYOC services with Diskless feature enabled. title: diskless.enable file_delete_delay_ms: type: integer minimum: 0 description: The time to wait before deleting a file from the filesystem. title: file.delete.delay.ms flush_messages: type: integer minimum: 0 description: This setting allows specifying an interval at which we will force an fsync of data written to the log. For example if this was set to 1 we would fsync after every message; if it were 5 we would fsync after every five messages. In general we recommend you not set this and use replication for durability and allow the operating system's background flush capabilities as it is more efficient. title: flush.messages flush_ms: type: integer minimum: 0 description: This setting allows specifying a time interval at which we will force an fsync of data written to the log. For example if this was set to 1000 we would fsync after 1000 ms had passed. In general we recommend you not set this and use replication for durability and allow the operating system's background flush capabilities as it is more efficient. title: flush.ms index_interval_bytes: type: integer minimum: 0 description: This setting controls how frequently Kafka adds an index entry to its offset index. The default setting ensures that we index a message roughly every 4096 bytes. More indexing allows reads to jump closer to the exact position in the log but makes the index larger. You probably don't need to change this. title: index.interval.bytes local_retention_bytes: type: integer description: This configuration controls the maximum bytes tiered storage will retain segment files locally before it will discard old log segments to free up space. If set to -2, the limit is equal to overall retention time. If set to -1, no limit is applied but it's possible only if overall retention is also -1. title: local.retention.bytes local_retention_ms: type: integer description: This configuration controls the maximum time tiered storage will retain segment files locally before it will discard old log segments to free up space. If set to -2, the time limit is equal to overall retention time. If set to -1, no time limit is applied but it's possible only if overall retention is also -1. title: local.retention.ms max_compaction_lag_ms: type: integer minimum: 0 description: The maximum time a message will remain ineligible for compaction in the log. Only applicable for logs that are being compacted. title: max.compaction.lag.ms max_message_bytes: type: integer minimum: 0 description: The largest record batch size allowed by Kafka (after compression if compression is enabled). If this is increased and there are consumers older than 0.10.2, the consumers' fetch size must also be increased so that the they can fetch record batches this large. In the latest message format version, records are always grouped into batches for efficiency. In previous message format versions, uncompressed records are not grouped into batches and this limit only applies to a single record in that case. title: max.message.bytes message_downconversion_enable: type: boolean description: This configuration controls whether down-conversion of message formats is enabled to satisfy consume requests. When set to false, broker will not perform down-conversion for consumers expecting an older message format. The broker responds with UNSUPPORTED_VERSION error for consume requests from such older clients. This configuration does not apply to any message format conversion that might be required for replication to followers. title: message.downconversion.enable message_format_version: type: string description: 'Specify the message format version the broker will use to append messages to the logs. The value should be a valid ApiVersion. Some examples are: 0.8.2, 0.9.0.0, 0.10.0, check ApiVersion for more details. By setting a particular message format version, the user is certifying that all the existing messages on disk are smaller or equal than the specified version. Setting this value incorrectly will cause consumers with older versions to break as they will receive messages with a format that they don''t understand. Deprecated in Kafka 4.0+: this configuration is removed and any supplied value will be ignored; for services upgraded to 4.0+, the returned value may be ''None''.' title: message.format.version enum: - 0.8.0 - 0.8.1 - 0.8.2 - 0.9.0 - 0.10.0 - 0.10.0-IV0 - 0.10.0-IV1 - 0.10.1 - 0.10.1-IV0 - 0.10.1-IV1 - 0.10.1-IV2 - 0.10.2 - 0.10.2-IV0 - 0.11.0 - 0.11.0-IV0 - 0.11.0-IV1 - 0.11.0-IV2 - '1.0' - 1.0-IV0 - '1.1' - 1.1-IV0 - '2.0' - 2.0-IV0 - 2.0-IV1 - '2.1' - 2.1-IV0 - 2.1-IV1 - 2.1-IV2 - '2.2' - 2.2-IV0 - 2.2-IV1 - '2.3' - 2.3-IV0 - 2.3-IV1 - '2.4' - 2.4-IV0 - 2.4-IV1 - '2.5' - 2.5-IV0 - '2.6' - 2.6-IV0 - '2.7' - 2.7-IV0 - 2.7-IV1 - 2.7-IV2 - '2.8' - 2.8-IV0 - 2.8-IV1 - '3.0' - 3.0-IV0 - 3.0-IV1 - '3.1' - 3.1-IV0 - '3.2' - 3.2-IV0 - '3.3' - 3.3-IV0 - 3.3-IV1 - 3.3-IV2 - 3.3-IV3 - '3.4' - 3.4-IV0 - '3.5' - 3.5-IV0 - 3.5-IV1 - 3.5-IV2 - '3.6' - 3.6-IV0 - 3.6-IV1 - 3.6-IV2 - '3.7' - 3.7-IV0 - 3.7-IV1 - 3.7-IV2 - 3.7-IV3 - 3.7-IV4 - '3.8' - 3.8-IV0 - '3.9' - 3.9-IV0 - 3.9-IV1 - '4.0' - 4.0-IV0 - '4.1' - 4.1-IV0 - '4.2' - 4.2-IV0 message_timestamp_after_max_ms: type: integer minimum: 0 description: The maximum difference allowed between the timestamp when a broker receives a message and the timestamp specified in the message. If message.timestamp.type=CreateTime, a message will be rejected if the difference in timestamp exceeds this threshold. Applies only for messages with timestamps later than the broker's timestamp. title: message.timestamp.after.max.ms message_timestamp_before_max_ms: type: integer minimum: 0 description: The maximum difference allowed between the timestamp when a broker receives a message and the timestamp specified in the message. If message.timestamp.type=CreateTime, a message will be rejected if the difference in timestamp exceeds this threshold. Applies only for messages with timestamps earlier than the broker's timestamp. title: message.timestamp.before.max.ms message_timestamp_difference_max_ms: type: integer minimum: 0 description: The maximum difference allowed between the timestamp when a broker receives a message and the timestamp specified in the message. If message.timestamp.type=CreateTime, a message will be rejected if the difference in timestamp exceeds this threshold. This configuration is ignored if message.timestamp.type=LogAppendTime. title: message.timestamp.difference.max.ms message_timestamp_type: type: string description: Define whether the timestamp in the message is message create time or log append time. title: message.timestamp.type enum: - CreateTime - LogAppendTime min_cleanable_dirty_ratio: type: number minimum: 0 maximum: 1 description: 'This configuration controls how frequently the log compactor will attempt to clean the log (assuming log compaction is enabled). By default we will avoid cleaning a log where more than 50% of the log has been compacted. This ratio bounds the maximum space wasted in the log by duplicates (at 50% at most 50% of the log could be duplicates). A higher ratio will mean fewer, more efficient cleanings but will mean more wasted space in the log. If the max.compaction.lag.ms or the min.compaction.lag.ms configurations are also specified, then the log compactor considers the log to be eligible for compaction as soon as either: (i) the dirty ratio threshold has been met and the log has had dirty (uncompacted) records for at least the min.compaction.lag.ms duration, or (ii) if the log has had dirty (uncompacted) records for at most the max.compaction.lag.ms period.' title: min.cleanable.dirty.ratio min_compaction_lag_ms: type: integer minimum: 0 description: The minimum time a message will remain uncompacted in the log. Only applicable for logs that are being compacted. title: min.compaction.lag.ms min_insync_replicas: type: integer minimum: 1 description: When a producer sets acks to 'all' (or '-1'), this configuration specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful. If this minimum cannot be met, then the producer will raise an exception (either NotEnoughReplicas or NotEnoughReplicasAfterAppend). When used together, min.insync.replicas and acks allow you to enforce greater durability guarantees. A typical scenario would be to create a topic with a replication factor of 3, set min.insync.replicas to 2, and produce with acks of 'all'. This will ensure that the producer raises an exception if a majority of replicas do not receive a write. title: min.insync.replicas preallocate: type: boolean description: True if we should preallocate the file on disk when creating a new log segment. title: preallocate remote_storage_enable: type: boolean description: Indicates whether tiered storage should be enabled. This is only available for services with Tiered Storage feature enabled. title: remote.storage.enable retention_bytes: type: integer description: This configuration controls the maximum size a partition (which consists of log segments) can grow to before we will discard old log segments to free up space if we are using the 'delete' retention policy. By default there is no size limit only a time limit. Since this limit is enforced at the partition level, multiply it by the number of partitions to compute the topic retention in bytes. title: retention.bytes retention_ms: type: integer description: This configuration controls the maximum time we will retain a log before we will discard old log segments to free up space if we are using the 'delete' retention policy. This represents an SLA on how soon consumers must read their data. If set to -1, no time limit is applied. title: retention.ms segment_bytes: type: integer minimum: 14 description: This configuration controls the segment file size for the log. Retention and cleaning is always done a file at a time so a larger segment size means fewer files but less granular control over retention. Setting this to a very low value has consequences, and the Aiven management plane ignores values less than 10 megabytes. title: segment.bytes segment_index_bytes: type: integer minimum: 0 description: This configuration controls the size of the index that maps offsets to file positions. We preallocate this index file and shrink it only after log rolls. You generally should not need to change this setting. title: segment.index.bytes segment_jitter_ms: type: integer minimum: 0 description: The maximum random jitter subtracted from the scheduled segment roll time to avoid thundering herds of segment rolling title: segment.jitter.ms segment_ms: type: integer minimum: 1 description: This configuration controls the period of time after which Kafka will force the log to roll even if the segment file isn't full to ensure that retention can delete or compact old data. Setting this to a very low value has consequences, and the Aiven management plane ignores values less than 10 seconds. title: segment.ms unclean_leader_election_enable: type: boolean description: Indicates whether to enable replicas not in the ISR set to be elected as leader as a last resort, even though doing so may result in data loss. title: unclean.leader.election.enable min_insync_replicas: type: integer minimum: 1 description: When a producer sets acks to 'all' (or '-1'), this configuration specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful. If this minimum cannot be met, then the producer will raise an exception (either NotEnoughReplicas or NotEnoughReplicasAfterAppend). When used together, min.insync.replicas and acks allow you to enforce greater durability guarantees. A typical scenario would be to create a topic with a replication factor of 3, set min.insync.replicas to 2, and produce with acks of 'all'. This will ensure that the producer raises an exception if a majority of replicas do not receive a write. title: 'DEPRECATED: use config.min_insync_replicas' owner_user_group_id: type: string minLength: 1 maxLength: 36 description: The user group that owns this topic partitions: type: integer minimum: 1 maximum: 1000000 description: Number of partitions replication: type: integer minimum: 1 description: Number of replicas retention_bytes: type: integer description: This configuration controls the maximum size a partition (which consists of log segments) can grow to before we will discard old log segments to free up space if we are using the 'delete' retention policy. By default there is no size limit only a time limit. Since this limit is enforced at the partition level, multiply it by the number of partitions to compute the topic retention in bytes. title: 'DEPRECATED: use config.retention_bytes' retention_hours: type: integer maximum: 2562047788015 description: 'DEPRECATED: use config.retention_ms' tags: type: array minItems: 0 maxItems: 25 description: Topic tags items: type: object properties: key: type: string minLength: 1 maxLength: 64 description: Tag key value: type: string minLength: 0 maxLength: 256 description: Tag value required: - key - value topic_description: type: string minLength: 1 maxLength: 256 description: Topic description ServiceKafkaAclDeleteResponse: type: object description: ServiceKafkaAclDeleteResponse properties: acl: type: array description: List of Aiven ACL entries for Kafka service items: type: object properties: id: type: string maxLength: 40 description: ID permission: type: string description: Kafka permission enum: - admin - read - readwrite - write topic: type: string minLength: 1 maxLength: 249 description: Topic name pattern username: type: string minLength: 1 maxLength: 64 description: Username required: - permission - topic - username errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request required: - acl ServiceKafkaConnectPauseConnectorResponse: type: object description: ServiceKafkaConnectPauseConnectorResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request ServiceKafkaNativeAclListResponse: type: object description: ServiceKafkaNativeAclListResponse properties: acl: type: array description: List of Aiven ACL entries for Kafka service items: type: object properties: id: type: string maxLength: 40 description: ID permission: type: string description: Kafka permission enum: - admin - read - readwrite - write topic: type: string minLength: 1 maxLength: 249 description: Topic name pattern username: type: string minLength: 1 maxLength: 64 description: Username required: - permission - topic - username errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status kafka_acl: type: array description: List of Kafka-native ACL entries items: type: object properties: host: type: string minLength: 0 maxLength: 256 description: the host or * for all hosts id: type: string maxLength: 40 description: ID operation: type: string description: Kafka ACL operation represents an operation which an ACL grants or denies permission to perform enum: - All - Alter - AlterConfigs - ClusterAction - Create - CreateTokens - Delete - Describe - DescribeConfigs - DescribeTokens - IdempotentWrite - Read - Write pattern_type: type: string description: Kafka ACL pattern type of resource name enum: - LITERAL - PREFIXED permission_type: type: string description: Kafka ACL permission type enum: - ALLOW - DENY principal: type: string minLength: 0 maxLength: 256 description: principal is in 'principalType:name' format resource_name: type: string minLength: 0 maxLength: 256 description: Resource pattern used to match specified resources resource_type: type: string description: Kafka ACL resource type represents a type of resource which an ACL can be applied to enum: - Cluster - DelegationToken - Group - Topic - TransactionalId - User required: - host - id - operation - pattern_type - permission_type - principal - resource_name - resource_type message: type: string description: Printable result of the request required: - acl - kafka_acl ServiceKafkaAclAddResponse: type: object description: ServiceKafkaAclAddResponse properties: acl: type: array description: List of Aiven ACL entries for Kafka service items: type: object properties: id: type: string maxLength: 40 description: ID permission: type: string description: Kafka permission enum: - admin - read - readwrite - write topic: type: string minLength: 1 maxLength: 249 description: Topic name pattern username: type: string minLength: 1 maxLength: 64 description: Username required: - permission - topic - username errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request required: - acl ServiceSchemaRegistrySubjectVersionGetResponse: type: object description: ServiceSchemaRegistrySubjectVersionGetResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request version: type: object description: Version properties: id: type: integer minimum: 0 description: Schema Id references: type: array maxItems: 128 description: Schema references items: type: object properties: name: type: string maxLength: 1024 description: The name used to reference the provided subject and version title: Name subject: type: string maxLength: 1024 description: Subject version: type: integer minimum: 0 description: Version required: - name - subject - version schema: type: string maxLength: 1048576 description: Schema schemaType: type: string description: Schema type enum: - AVRO - JSON - PROTOBUF subject: type: string maxLength: 1024 description: Subject version: type: integer minimum: 0 description: Version required: - id - schema - subject - version required: - version ServiceKafkaTopicMessageListResponse: type: object description: ServiceKafkaTopicMessageListResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request messages: type: array description: List of messages from topic items: type: object properties: key: type: object description: The message key, formatted according to the embedded format properties: {} offset: type: integer description: Offset of the message partition: type: integer description: Partition of the message topic: type: string description: The name of the topic value: type: object description: The message value, formatted according to the embedded format properties: {} ServiceKafkaNativeAclGetResponse: type: object description: ServiceKafkaNativeAclGetResponse properties: acl: type: object description: Kafka-native ACL entry for Kafka service properties: host: type: string minLength: 0 maxLength: 256 description: the host or * for all hosts id: type: string maxLength: 40 description: ID operation: type: string description: Kafka ACL operation represents an operation which an ACL grants or denies permission to perform enum: - All - Alter - AlterConfigs - ClusterAction - Create - CreateTokens - Delete - Describe - DescribeConfigs - DescribeTokens - IdempotentWrite - Read - Write pattern_type: type: string description: Kafka ACL pattern type of resource name enum: - LITERAL - PREFIXED permission_type: type: string description: Kafka ACL permission type enum: - ALLOW - DENY principal: type: string minLength: 0 maxLength: 256 description: principal is in 'principalType:name' format resource_name: type: string minLength: 0 maxLength: 256 description: Resource pattern used to match specified resources resource_type: type: string description: Kafka ACL resource type represents a type of resource which an ACL can be applied to enum: - Cluster - DelegationToken - Group - Topic - TransactionalId - User required: - host - id - operation - pattern_type - permission_type - principal - resource_name - resource_type errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request required: - acl ServiceKafkaConnectEditConnectorResponse: type: object description: ServiceKafkaConnectEditConnectorResponse properties: connector: type: object description: Kafka connector information properties: config: type: object description: Connector configuration parameters properties: connector.class: type: string maxLength: 1024 description: The Java class for the connector name: type: string maxLength: 1024 description: Unique name for the connector required: - connector.class - name name: type: string maxLength: 1024 description: Connector name plugin: type: object description: Kafka Connector plugin information properties: author: type: string description: Connector author name available_versions: type: array description: Versions available on the service items: type: object properties: deprecated: type: boolean description: If the version is deprecated. needs_maintenance: type: boolean description: Using this version requires a maintenance update. version: type: string description: Connector version number class: type: string description: Connector class name docURL: type: string description: Connector documentation URL plugin_name: type: string description: Connector plugin name preview: type: boolean description: Describes if connector is in beta preview_info: type: string description: Information about beta stage of connector title: type: string description: Descriptive human readable name defined by Aiven type: type: string description: Describes whether data flows from or to Kafka enum: - sink - source - unknown version: type: string description: Connector version number required: - author - class - docURL - title - type - version tasks: type: array description: List of tasks of a connector items: type: object properties: connector: type: string description: Related connector name task: type: integer description: Task id / number required: - connector - task required: - config - name - plugin - tasks errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request required: - connector ServiceKafkaConnectGetConnectorConfigurationResponse: type: object description: ServiceKafkaConnectGetConnectorConfigurationResponse properties: configuration_schema: type: array description: List of connector configuration field definitions items: type: object properties: default_value: type: string description: Default value to be set if field omitted in configuration display_name: type: string description: Human friendly name of the field documentation: type: string description: Assisting help text group: type: string description: Name of the field group to which the field belongs to importance: type: string description: How important is the field enum: - LOW - MEDIUM - HIGH name: type: string description: Machine friendly name of the field order: type: integer description: Position of the field in the configuration form order_in_group: type: integer description: Position of the field in the configuration form (Kafka 4.x name, alias of order) required: type: boolean description: Defines if the field value is mandatory or not type: type: string description: Configuration value type enum: - STRING - INT - SHORT - LONG - DOUBLE - BOOLEAN - LIST - CLASS - PASSWORD width: type: string description: Expected length of the input value enum: - NONE - SHORT - MEDIUM - LONG required: - default_value - display_name - documentation - group - importance - name - order - order_in_group - required - type - width errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request required: - configuration_schema ServiceKafkaConnectCreateConnectorResponse: type: object description: ServiceKafkaConnectCreateConnectorResponse properties: connector: type: object description: Kafka connector information properties: config: type: object description: Connector configuration parameters properties: connector.class: type: string maxLength: 1024 description: The Java class for the connector name: type: string maxLength: 1024 description: Unique name for the connector required: - connector.class - name name: type: string maxLength: 1024 description: Connector name plugin: type: object description: Kafka Connector plugin information properties: author: type: string description: Connector author name available_versions: type: array description: Versions available on the service items: type: object properties: deprecated: type: boolean description: If the version is deprecated. needs_maintenance: type: boolean description: Using this version requires a maintenance update. version: type: string description: Connector version number class: type: string description: Connector class name docURL: type: string description: Connector documentation URL plugin_name: type: string description: Connector plugin name preview: type: boolean description: Describes if connector is in beta preview_info: type: string description: Information about beta stage of connector title: type: string description: Descriptive human readable name defined by Aiven type: type: string description: Describes whether data flows from or to Kafka enum: - sink - source - unknown version: type: string description: Connector version number required: - author - class - docURL - title - type - version tasks: type: array description: List of tasks of a connector items: type: object properties: connector: type: string description: Related connector name task: type: integer description: Task id / number required: - connector - task required: - config - name - plugin - tasks errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request required: - connector ServiceSchemaRegistryAclAddRequestBody: type: object description: ServiceSchemaRegistryAclAddRequestBody properties: permission: type: string description: ACL entry for Schema Registry enum: - schema_registry_read - schema_registry_write resource: type: string minLength: 1 maxLength: 249 description: Schema Registry ACL entry resource name pattern username: type: string minLength: 1 maxLength: 64 description: Username required: - permission - resource - username ServiceKafkaAclAddRequestBody: type: object description: ServiceKafkaAclAddRequestBody properties: permission: type: string description: Kafka permission enum: - admin - read - readwrite - write topic: type: string minLength: 1 maxLength: 249 description: Topic name pattern username: type: string minLength: 1 maxLength: 64 description: Username required: - permission - topic - username ServiceKafkaConnectStopConnectorResponse: type: object description: ServiceKafkaConnectStopConnectorResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request ServiceSchemaRegistryCompatibilityRequestBody: type: object description: ServiceSchemaRegistryCompatibilityRequestBody properties: schema: type: string maxLength: 1048576 description: Schema schemaType: type: string description: Schema type enum: - AVRO - JSON - PROTOBUF required: - schema ServiceKafkaConnectRestartConnectorResponse: type: object description: ServiceKafkaConnectRestartConnectorResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request ServiceSchemaRegistrySubjectConfigPutResponse: type: object description: ServiceSchemaRegistrySubjectConfigPutResponse properties: compatibility: type: string description: Compatibility level enum: - BACKWARD - BACKWARD_TRANSITIVE - FORWARD - FORWARD_TRANSITIVE - FULL - FULL_TRANSITIVE - NONE errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request required: - compatibility ServiceKafkaConnectGetAvailableConnectorsResponse: type: object description: ServiceKafkaConnectGetAvailableConnectorsResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request plugins: type: array description: List of available Kafka Connect connector plugins items: type: object properties: author: type: string description: Connector author name available_versions: type: array description: Versions available on the service items: type: object properties: deprecated: type: boolean description: If the version is deprecated. needs_maintenance: type: boolean description: Using this version requires a maintenance update. version: type: string description: Connector version number class: type: string description: Connector class name docURL: type: string description: Connector documentation URL plugin_name: type: string description: Connector plugin name preview: type: boolean description: Describes if connector is in beta preview_info: type: string description: Information about beta stage of connector title: type: string description: Descriptive human readable name defined by Aiven type: type: string description: Describes whether data flows from or to Kafka enum: - sink - source - unknown version: type: string description: Connector version number required: - author - class - docURL - title - type - version required: - plugins ServiceSchemaRegistryGlobalConfigGetResponse: type: object description: ServiceSchemaRegistryGlobalConfigGetResponse properties: compatibilityLevel: type: string description: Compatibility level enum: - BACKWARD - BACKWARD_TRANSITIVE - FORWARD - FORWARD_TRANSITIVE - FULL - FULL_TRANSITIVE - NONE errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request required: - compatibilityLevel ServiceSchemaRegistryGlobalConfigPutResponse: type: object description: ServiceSchemaRegistryGlobalConfigPutResponse properties: compatibility: type: string description: Compatibility level enum: - BACKWARD - BACKWARD_TRANSITIVE - FORWARD - FORWARD_TRANSITIVE - FULL - FULL_TRANSITIVE - NONE errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request required: - compatibility ServiceKafkaNativeAclAddRequestBody: type: object description: ServiceKafkaNativeAclAddRequestBody properties: host: type: string minLength: 0 maxLength: 256 description: the host or * for all hosts operation: type: string description: Kafka ACL operation represents an operation which an ACL grants or denies permission to perform enum: - All - Alter - AlterConfigs - ClusterAction - Create - CreateTokens - Delete - Describe - DescribeConfigs - DescribeTokens - IdempotentWrite - Read - Write pattern_type: type: string description: Kafka ACL pattern type of resource name default: LITERAL enum: - LITERAL - PREFIXED permission_type: type: string description: Kafka ACL permission type default: ALLOW enum: - ALLOW - DENY principal: type: string minLength: 0 maxLength: 256 description: principal is in 'PrincipalType:name' format resource_name: type: string minLength: 0 maxLength: 256 description: Resource pattern used to match specified resources resource_type: type: string description: Kafka ACL resource type represents a type of resource which an ACL can be applied to enum: - Cluster - DelegationToken - Group - Topic - TransactionalId - User required: - operation - pattern_type - permission_type - principal - resource_name - resource_type ServiceKafkaConnectRestartConnectorTaskResponse: type: object description: ServiceKafkaConnectRestartConnectorTaskResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request ServiceKafkaConnectEditConnectorRequestBody: type: object description: ServiceKafkaConnectEditConnectorRequestBody properties: connector.class: type: string maxLength: 1024 description: The Java class for the connector name: type: string maxLength: 1024 description: Unique name for the connector required: - connector.class - name ServiceKafkaTopicMessageListRequestBody: type: object description: ServiceKafkaTopicMessageListRequestBody properties: format: type: string description: The format of consumed messages, which is used to convert messages into a JSON-compatible form. If unspecified, defaults to binary enum: - binary - json - avro - protobuf - jsonschema max_bytes: type: integer minimum: 1024 maximum: 1000000000 description: The maximum number of bytes of unencoded keys and values that should be included in the response. This provides approximate control over the size of responses and the amount of memory required to store the decoded response. The actual limit will be the minimum of this setting and the server-side configuration consumer.request.max.bytes. Default is unlimited partitions: type: object description: Object of desired partition / offset mappings properties: {} timeout: type: integer minimum: 3000 maximum: 40000 description: The maximum total time to wait for messages for a request if the maximum request size has not yet been reached required: - partitions ServiceSchemaRegistrySubjectVersionPostResponse: type: object description: ServiceSchemaRegistrySubjectVersionPostResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status id: type: integer minimum: 0 description: Schema Id message: type: string description: Printable result of the request required: - id ServiceKafkaTopicCreateRequestBody: type: object description: ServiceKafkaTopicCreateRequestBody properties: cleanup_policy: type: string description: The retention policy to use on old segments. Possible values include 'delete', 'compact', or a comma-separated list of them. The default policy ('delete') will discard old segments when their retention time or size limit has been reached. The 'compact' setting will enable log compaction on the topic. title: 'DEPRECATED: use config.cleanup_policy' enum: - delete - compact - compact,delete config: type: object description: Kafka topic configuration properties: cleanup_policy: type: string description: The retention policy to use on old segments. Possible values include 'delete', 'compact', or a comma-separated list of them. The default policy ('delete') will discard old segments when their retention time or size limit has been reached. The 'compact' setting will enable log compaction on the topic. title: cleanup.policy enum: - delete - compact - compact,delete compression_type: type: string description: Specify the final compression type for a given topic. This configuration accepts the standard compression codecs ('gzip', 'snappy', 'lz4', 'zstd'). It additionally accepts 'uncompressed' which is equivalent to no compression; and 'producer' which means retain the original compression codec set by the producer. title: compression.type enum: - snappy - gzip - lz4 - producer - uncompressed - zstd delete_retention_ms: type: integer minimum: 0 description: The amount of time to retain delete tombstone markers for log compacted topics. This setting also gives a bound on the time in which a consumer must complete a read if they begin from offset 0 to ensure that they get a valid snapshot of the final stage (otherwise delete tombstones may be collected before they complete their scan). title: delete.retention.ms diskless_enable: type: boolean description: Indicates whether diskless should be enabled. This is only available for BYOC services with Diskless feature enabled. title: diskless.enable file_delete_delay_ms: type: integer minimum: 0 description: The time to wait before deleting a file from the filesystem. title: file.delete.delay.ms flush_messages: type: integer minimum: 0 description: This setting allows specifying an interval at which we will force an fsync of data written to the log. For example if this was set to 1 we would fsync after every message; if it were 5 we would fsync after every five messages. In general we recommend you not set this and use replication for durability and allow the operating system's background flush capabilities as it is more efficient. title: flush.messages flush_ms: type: integer minimum: 0 description: This setting allows specifying a time interval at which we will force an fsync of data written to the log. For example if this was set to 1000 we would fsync after 1000 ms had passed. In general we recommend you not set this and use replication for durability and allow the operating system's background flush capabilities as it is more efficient. title: flush.ms index_interval_bytes: type: integer minimum: 0 description: This setting controls how frequently Kafka adds an index entry to its offset index. The default setting ensures that we index a message roughly every 4096 bytes. More indexing allows reads to jump closer to the exact position in the log but makes the index larger. You probably don't need to change this. title: index.interval.bytes local_retention_bytes: type: integer description: This configuration controls the maximum bytes tiered storage will retain segment files locally before it will discard old log segments to free up space. If set to -2, the limit is equal to overall retention time. If set to -1, no limit is applied but it's possible only if overall retention is also -1. title: local.retention.bytes local_retention_ms: type: integer description: This configuration controls the maximum time tiered storage will retain segment files locally before it will discard old log segments to free up space. If set to -2, the time limit is equal to overall retention time. If set to -1, no time limit is applied but it's possible only if overall retention is also -1. title: local.retention.ms max_compaction_lag_ms: type: integer minimum: 0 description: The maximum time a message will remain ineligible for compaction in the log. Only applicable for logs that are being compacted. title: max.compaction.lag.ms max_message_bytes: type: integer minimum: 0 description: The largest record batch size allowed by Kafka (after compression if compression is enabled). If this is increased and there are consumers older than 0.10.2, the consumers' fetch size must also be increased so that the they can fetch record batches this large. In the latest message format version, records are always grouped into batches for efficiency. In previous message format versions, uncompressed records are not grouped into batches and this limit only applies to a single record in that case. title: max.message.bytes message_downconversion_enable: type: boolean description: This configuration controls whether down-conversion of message formats is enabled to satisfy consume requests. When set to false, broker will not perform down-conversion for consumers expecting an older message format. The broker responds with UNSUPPORTED_VERSION error for consume requests from such older clients. This configuration does not apply to any message format conversion that might be required for replication to followers. title: message.downconversion.enable message_format_version: type: string description: 'Specify the message format version the broker will use to append messages to the logs. The value should be a valid ApiVersion. Some examples are: 0.8.2, 0.9.0.0, 0.10.0, check ApiVersion for more details. By setting a particular message format version, the user is certifying that all the existing messages on disk are smaller or equal than the specified version. Setting this value incorrectly will cause consumers with older versions to break as they will receive messages with a format that they don''t understand. Deprecated in Kafka 4.0+: this configuration is removed and any supplied value will be ignored; for services upgraded to 4.0+, the returned value may be ''None''.' title: message.format.version enum: - 0.8.0 - 0.8.1 - 0.8.2 - 0.9.0 - 0.10.0 - 0.10.0-IV0 - 0.10.0-IV1 - 0.10.1 - 0.10.1-IV0 - 0.10.1-IV1 - 0.10.1-IV2 - 0.10.2 - 0.10.2-IV0 - 0.11.0 - 0.11.0-IV0 - 0.11.0-IV1 - 0.11.0-IV2 - '1.0' - 1.0-IV0 - '1.1' - 1.1-IV0 - '2.0' - 2.0-IV0 - 2.0-IV1 - '2.1' - 2.1-IV0 - 2.1-IV1 - 2.1-IV2 - '2.2' - 2.2-IV0 - 2.2-IV1 - '2.3' - 2.3-IV0 - 2.3-IV1 - '2.4' - 2.4-IV0 - 2.4-IV1 - '2.5' - 2.5-IV0 - '2.6' - 2.6-IV0 - '2.7' - 2.7-IV0 - 2.7-IV1 - 2.7-IV2 - '2.8' - 2.8-IV0 - 2.8-IV1 - '3.0' - 3.0-IV0 - 3.0-IV1 - '3.1' - 3.1-IV0 - '3.2' - 3.2-IV0 - '3.3' - 3.3-IV0 - 3.3-IV1 - 3.3-IV2 - 3.3-IV3 - '3.4' - 3.4-IV0 - '3.5' - 3.5-IV0 - 3.5-IV1 - 3.5-IV2 - '3.6' - 3.6-IV0 - 3.6-IV1 - 3.6-IV2 - '3.7' - 3.7-IV0 - 3.7-IV1 - 3.7-IV2 - 3.7-IV3 - 3.7-IV4 - '3.8' - 3.8-IV0 - '3.9' - 3.9-IV0 - 3.9-IV1 - '4.0' - 4.0-IV0 - '4.1' - 4.1-IV0 - '4.2' - 4.2-IV0 message_timestamp_after_max_ms: type: integer minimum: 0 description: The maximum difference allowed between the timestamp when a broker receives a message and the timestamp specified in the message. If message.timestamp.type=CreateTime, a message will be rejected if the difference in timestamp exceeds this threshold. Applies only for messages with timestamps later than the broker's timestamp. title: message.timestamp.after.max.ms message_timestamp_before_max_ms: type: integer minimum: 0 description: The maximum difference allowed between the timestamp when a broker receives a message and the timestamp specified in the message. If message.timestamp.type=CreateTime, a message will be rejected if the difference in timestamp exceeds this threshold. Applies only for messages with timestamps earlier than the broker's timestamp. title: message.timestamp.before.max.ms message_timestamp_difference_max_ms: type: integer minimum: 0 description: The maximum difference allowed between the timestamp when a broker receives a message and the timestamp specified in the message. If message.timestamp.type=CreateTime, a message will be rejected if the difference in timestamp exceeds this threshold. This configuration is ignored if message.timestamp.type=LogAppendTime. title: message.timestamp.difference.max.ms message_timestamp_type: type: string description: Define whether the timestamp in the message is message create time or log append time. title: message.timestamp.type enum: - CreateTime - LogAppendTime min_cleanable_dirty_ratio: type: number minimum: 0 maximum: 1 description: 'This configuration controls how frequently the log compactor will attempt to clean the log (assuming log compaction is enabled). By default we will avoid cleaning a log where more than 50% of the log has been compacted. This ratio bounds the maximum space wasted in the log by duplicates (at 50% at most 50% of the log could be duplicates). A higher ratio will mean fewer, more efficient cleanings but will mean more wasted space in the log. If the max.compaction.lag.ms or the min.compaction.lag.ms configurations are also specified, then the log compactor considers the log to be eligible for compaction as soon as either: (i) the dirty ratio threshold has been met and the log has had dirty (uncompacted) records for at least the min.compaction.lag.ms duration, or (ii) if the log has had dirty (uncompacted) records for at most the max.compaction.lag.ms period.' title: min.cleanable.dirty.ratio min_compaction_lag_ms: type: integer minimum: 0 description: The minimum time a message will remain uncompacted in the log. Only applicable for logs that are being compacted. title: min.compaction.lag.ms min_insync_replicas: type: integer minimum: 1 description: When a producer sets acks to 'all' (or '-1'), this configuration specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful. If this minimum cannot be met, then the producer will raise an exception (either NotEnoughReplicas or NotEnoughReplicasAfterAppend). When used together, min.insync.replicas and acks allow you to enforce greater durability guarantees. A typical scenario would be to create a topic with a replication factor of 3, set min.insync.replicas to 2, and produce with acks of 'all'. This will ensure that the producer raises an exception if a majority of replicas do not receive a write. title: min.insync.replicas preallocate: type: boolean description: True if we should preallocate the file on disk when creating a new log segment. title: preallocate remote_storage_enable: type: boolean description: Indicates whether tiered storage should be enabled. This is only available for services with Tiered Storage feature enabled. title: remote.storage.enable retention_bytes: type: integer description: This configuration controls the maximum size a partition (which consists of log segments) can grow to before we will discard old log segments to free up space if we are using the 'delete' retention policy. By default there is no size limit only a time limit. Since this limit is enforced at the partition level, multiply it by the number of partitions to compute the topic retention in bytes. title: retention.bytes retention_ms: type: integer description: This configuration controls the maximum time we will retain a log before we will discard old log segments to free up space if we are using the 'delete' retention policy. This represents an SLA on how soon consumers must read their data. If set to -1, no time limit is applied. title: retention.ms segment_bytes: type: integer minimum: 14 description: This configuration controls the segment file size for the log. Retention and cleaning is always done a file at a time so a larger segment size means fewer files but less granular control over retention. Setting this to a very low value has consequences, and the Aiven management plane ignores values less than 10 megabytes. title: segment.bytes segment_index_bytes: type: integer minimum: 0 description: This configuration controls the size of the index that maps offsets to file positions. We preallocate this index file and shrink it only after log rolls. You generally should not need to change this setting. title: segment.index.bytes segment_jitter_ms: type: integer minimum: 0 description: The maximum random jitter subtracted from the scheduled segment roll time to avoid thundering herds of segment rolling title: segment.jitter.ms segment_ms: type: integer minimum: 1 description: This configuration controls the period of time after which Kafka will force the log to roll even if the segment file isn't full to ensure that retention can delete or compact old data. Setting this to a very low value has consequences, and the Aiven management plane ignores values less than 10 seconds. title: segment.ms unclean_leader_election_enable: type: boolean description: Indicates whether to enable replicas not in the ISR set to be elected as leader as a last resort, even though doing so may result in data loss. title: unclean.leader.election.enable min_insync_replicas: type: integer minimum: 1 description: When a producer sets acks to 'all' (or '-1'), this configuration specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful. If this minimum cannot be met, then the producer will raise an exception (either NotEnoughReplicas or NotEnoughReplicasAfterAppend). When used together, min.insync.replicas and acks allow you to enforce greater durability guarantees. A typical scenario would be to create a topic with a replication factor of 3, set min.insync.replicas to 2, and produce with acks of 'all'. This will ensure that the producer raises an exception if a majority of replicas do not receive a write. title: 'DEPRECATED: use config.min_insync_replicas' owner_user_group_id: type: string minLength: 1 maxLength: 36 description: The user group that owns this topic partitions: type: integer minimum: 1 maximum: 1000000 description: Number of partitions replication: type: integer minimum: 1 description: Number of replicas retention_bytes: type: integer description: This configuration controls the maximum size a partition (which consists of log segments) can grow to before we will discard old log segments to free up space if we are using the 'delete' retention policy. By default there is no size limit only a time limit. Since this limit is enforced at the partition level, multiply it by the number of partitions to compute the topic retention in bytes. title: 'DEPRECATED: use config.retention_bytes' retention_hours: type: integer maximum: 2562047788015 description: 'DEPRECATED: use config.retention_ms' tags: type: array minItems: 0 maxItems: 25 description: Topic tags items: type: object properties: key: type: string minLength: 1 maxLength: 64 description: Tag key value: type: string minLength: 0 maxLength: 256 description: Tag value required: - key - value topic_description: type: string minLength: 1 maxLength: 256 description: Topic description topic_name: type: string minLength: 1 maxLength: 249 description: Topic name required: - topic_name ServiceSchemaRegistrySubjectVersionSchemaGetResponse: type: object description: ServiceSchemaRegistrySubjectVersionSchemaGetResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request ServiceKafkaTieredStorageStorageUsageTotalResponse: type: object description: ServiceKafkaTieredStorageStorageUsageTotalResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request total_storage_usage: type: integer minimum: 0 description: Total storage usage by tiered storage, in bytes required: - total_storage_usage ServiceSchemaRegistrySubjectVersionPostRequestBody: type: object description: ServiceSchemaRegistrySubjectVersionPostRequestBody properties: references: type: array maxItems: 128 description: Schema references items: type: object properties: name: type: string maxLength: 1024 description: The name used to reference the provided subject and version title: Name subject: type: string maxLength: 1024 description: Subject version: type: integer minimum: 0 description: Version required: - name - subject - version schema: type: string maxLength: 1048576 description: Schema schemaType: type: string description: Schema type enum: - AVRO - JSON - PROTOBUF required: - schema ServiceKafkaConnectListResponse: type: object description: ServiceKafkaConnectListResponse properties: connectors: type: array description: List of active Kafka Connect connectors items: type: object properties: config: type: object description: Connector configuration parameters properties: connector.class: type: string maxLength: 1024 description: The Java class for the connector name: type: string maxLength: 1024 description: Unique name for the connector required: - connector.class - name name: type: string maxLength: 1024 description: Connector name plugin: type: object description: Kafka Connector plugin information properties: author: type: string description: Connector author name available_versions: type: array description: Versions available on the service items: type: object properties: deprecated: type: boolean description: If the version is deprecated. needs_maintenance: type: boolean description: Using this version requires a maintenance update. version: type: string description: Connector version number class: type: string description: Connector class name docURL: type: string description: Connector documentation URL plugin_name: type: string description: Connector plugin name preview: type: boolean description: Describes if connector is in beta preview_info: type: string description: Information about beta stage of connector title: type: string description: Descriptive human readable name defined by Aiven type: type: string description: Describes whether data flows from or to Kafka enum: - sink - source - unknown version: type: string description: Connector version number required: - author - class - docURL - title - type - version tasks: type: array description: List of tasks of a connector items: type: object properties: connector: type: string description: Related connector name task: type: integer description: Task id / number required: - connector - task required: - config - name - plugin - tasks errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status failed_connectors: type: array description: List of connectors that failed plugin resolution items: type: object properties: config: type: object description: Connector configuration parameters properties: connector.class: type: string maxLength: 1024 description: The Java class for the connector name: type: string maxLength: 1024 description: Unique name for the connector required: - connector.class - name error: type: string description: Error message explaining why the connector failed to load name: type: string maxLength: 1024 description: Connector name required: - config - error - name message: type: string description: Printable result of the request required: - connectors ServiceKafkaTopicListResponse: type: object description: ServiceKafkaTopicListResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request topics: type: array description: List of Kafka topics items: type: object properties: cleanup_policy: type: string maxLength: 64 description: The retention policy to use on old segments. Possible values include 'delete', 'compact', or a comma-separated list of them. The default policy ('delete') will discard old segments when their retention time or size limit has been reached. The 'compact' setting will enable log compaction on the topic. title: cleanup.policy diskless_enable: type: boolean description: Indicates whether diskless should be enabled. This is only available for BYOC services with Diskless feature enabled. title: diskless.enable min_insync_replicas: type: integer minimum: 1 description: When a producer sets acks to 'all' (or '-1'), this configuration specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful. If this minimum cannot be met, then the producer will raise an exception (either NotEnoughReplicas or NotEnoughReplicasAfterAppend). When used together, min.insync.replicas and acks allow you to enforce greater durability guarantees. A typical scenario would be to create a topic with a replication factor of 3, set min.insync.replicas to 2, and produce with acks of 'all'. This will ensure that the producer raises an exception if a majority of replicas do not receive a write. title: min.insync.replicas owner_user_group_id: type: string minLength: 1 maxLength: 36 description: The user group that owns this topic partitions: type: integer minimum: 1 maximum: 1000000 description: Number of partitions remote_storage_enable: type: boolean description: Indicates whether tiered storage should be enabled. This is only available for services with Tiered Storage feature enabled. title: remote.storage.enable replication: type: integer minimum: 1 description: Number of replicas retention_bytes: type: integer description: This configuration controls the maximum size a partition (which consists of log segments) can grow to before we will discard old log segments to free up space if we are using the 'delete' retention policy. By default there is no size limit only a time limit. Since this limit is enforced at the partition level, multiply it by the number of partitions to compute the topic retention in bytes. title: retention.bytes retention_hours: type: integer maximum: 2562047788015 description: Retention period (hours) state: type: string description: Topic state enum: - ACTIVE - CONFIGURING - DELETING tags: type: array minItems: 0 maxItems: 25 description: Topic tags items: type: object properties: key: type: string minLength: 1 maxLength: 64 description: Tag key value: type: string minLength: 0 maxLength: 256 description: Tag value required: - key - value topic_description: type: string minLength: 1 maxLength: 256 description: Topic description topic_name: type: string minLength: 1 maxLength: 249 description: Topic name required: - cleanup_policy - min_insync_replicas - owner_user_group_id - partitions - replication - retention_bytes - retention_hours - state - tags - topic_description - topic_name required: - topics ServiceSchemaRegistryAclAddResponse: type: object description: ServiceSchemaRegistryAclAddResponse properties: acl: type: array description: List of Schema Registry ACL entries items: type: object properties: id: type: string maxLength: 40 description: ID permission: type: string description: ACL entry for Schema Registry enum: - schema_registry_read - schema_registry_write resource: type: string minLength: 1 maxLength: 249 description: Schema Registry ACL entry resource name pattern username: type: string minLength: 1 maxLength: 64 description: Username required: - permission - resource - username errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request required: - acl ServiceSchemaRegistrySubjectConfigPutRequestBody: type: object description: ServiceSchemaRegistrySubjectConfigPutRequestBody properties: compatibility: type: string description: Compatibility level enum: - BACKWARD - BACKWARD_TRANSITIVE - FORWARD - FORWARD_TRANSITIVE - FULL - FULL_TRANSITIVE - NONE required: - compatibility ServiceKafkaAclListResponse: type: object description: ServiceKafkaAclListResponse properties: acl: type: array description: List of Aiven ACL entries for Kafka service items: type: object properties: id: type: string maxLength: 40 description: ID permission: type: string description: Kafka permission enum: - admin - read - readwrite - write topic: type: string minLength: 1 maxLength: 249 description: Topic name pattern username: type: string minLength: 1 maxLength: 64 description: Username required: - permission - topic - username errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request required: - acl ServiceKafkaQuotaDeleteResponse: type: object description: ServiceKafkaQuotaDeleteResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request ServiceSchemaRegistrySubjectConfigGetResponse: type: object description: ServiceSchemaRegistrySubjectConfigGetResponse properties: compatibilityLevel: type: string description: Compatibility level enum: - BACKWARD - BACKWARD_TRANSITIVE - FORWARD - FORWARD_TRANSITIVE - FULL - FULL_TRANSITIVE - NONE errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request required: - compatibilityLevel ServiceSchemaRegistrySubjectsResponse: type: object description: ServiceSchemaRegistrySubjectsResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request subjects: type: array description: List of available Schema Registry subjects items: type: string required: - subjects ServiceKafkaConnectCreateConnectorRequestBody: type: object description: ServiceKafkaConnectCreateConnectorRequestBody properties: connector.class: type: string maxLength: 1024 description: The Java class for the connector name: type: string maxLength: 1024 description: Unique name for the connector required: - connector.class - name ServiceSchemaRegistryGlobalConfigPutRequestBody: type: object description: ServiceSchemaRegistryGlobalConfigPutRequestBody properties: compatibility: type: string description: Compatibility level enum: - BACKWARD - BACKWARD_TRANSITIVE - FORWARD - FORWARD_TRANSITIVE - FULL - FULL_TRANSITIVE - NONE required: - compatibility ServiceKafkaQuotaDescribeResponse: type: object description: ServiceKafkaQuotaDescribeResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request quota: type: object description: kafka quota properties: client\-id: type: string maxLength: 255 description: Represents a logical group of clients, assigned a unique name by the client application. Quotas can be applied based on user, client-id, or both. The most relevant quota is chosen for each connection. All connections within a quota group share the same quota. title: client-id consumer_byte_rate: type: number minimum: 0 maximum: 1073741824 description: Defines the bandwidth limit in bytes/sec for each group of clients sharing a quota. Every distinct client group is allocated a specific quota, as defined by the cluster, on a per-broker basis. Exceeding this limit results in client throttling. title: consumer network throttle producer_byte_rate: type: number minimum: 0 maximum: 1073741824 description: Defines the bandwidth limit in bytes/sec for each group of clients sharing a quota. Every distinct client group is allocated a specific quota, as defined by the cluster, on a per-broker basis. Exceeding this limit results in client throttling. title: producer network throttle request_percentage: type: number description: Sets the maximum percentage of CPU time that a client group can use on request handler I/O and network threads per broker within a quota window. Exceeding this limit triggers throttling. The quota, expressed as a percentage, also indicates the total allowable CPU usage for the client groups sharing the quota. title: cpu percentage throttle user: type: string maxLength: 64 description: Represents a logical group of clients, assigned a unique name by the client application. Quotas can be applied based on user, client-id, or both. The most relevant quota is chosen for each connection. All connections within a quota group share the same quota. title: user required: - client\-id - consumer_byte_rate - producer_byte_rate - request_percentage - user required: - quota ServiceKafkaConnectDeleteConnectorResponse: type: object description: ServiceKafkaConnectDeleteConnectorResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request ServiceKafkaQuotaListResponse: type: object description: ServiceKafkaQuotaListResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request quotas: type: array description: List of kafka quotas items: type: object properties: client\-id: type: string maxLength: 255 description: Represents a logical group of clients, assigned a unique name by the client application. Quotas can be applied based on user, client-id, or both. The most relevant quota is chosen for each connection. All connections within a quota group share the same quota. title: client-id consumer_byte_rate: type: number minimum: 0 maximum: 1073741824 description: Defines the bandwidth limit in bytes/sec for each group of clients sharing a quota. Every distinct client group is allocated a specific quota, as defined by the cluster, on a per-broker basis. Exceeding this limit results in client throttling. title: consumer network throttle producer_byte_rate: type: number minimum: 0 maximum: 1073741824 description: Defines the bandwidth limit in bytes/sec for each group of clients sharing a quota. Every distinct client group is allocated a specific quota, as defined by the cluster, on a per-broker basis. Exceeding this limit results in client throttling. title: producer network throttle request_percentage: type: number description: Sets the maximum percentage of CPU time that a client group can use on request handler I/O and network threads per broker within a quota window. Exceeding this limit triggers throttling. The quota, expressed as a percentage, also indicates the total allowable CPU usage for the client groups sharing the quota. title: cpu percentage throttle user: type: string maxLength: 64 description: Represents a logical group of clients, assigned a unique name by the client application. Quotas can be applied based on user, client-id, or both. The most relevant quota is chosen for each connection. All connections within a quota group share the same quota. title: user required: - client\-id - consumer_byte_rate - producer_byte_rate - request_percentage - user required: - quotas ServiceKafkaTopicGetResponse: type: object description: ServiceKafkaTopicGetResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request topic: type: object description: Kafka topic information properties: cleanup_policy: type: string maxLength: 64 description: The retention policy to use on old segments. Possible values include 'delete', 'compact', or a comma-separated list of them. The default policy ('delete') will discard old segments when their retention time or size limit has been reached. The 'compact' setting will enable log compaction on the topic. title: 'DEPRECATED: use config.cleanup_policy' config: type: object description: Kafka topic configuration properties: cleanup_policy: type: object description: cleanup.policy value, source and synonyms properties: source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config synonyms: type: array description: Configuration synonyms items: type: object properties: name: type: string description: Synonym name source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config value: type: string description: Synonym value required: - name - source - value value: type: string maxLength: 64 description: The retention policy to use on old segments. Possible values include 'delete', 'compact', or a comma-separated list of them. The default policy ('delete') will discard old segments when their retention time or size limit has been reached. The 'compact' setting will enable log compaction on the topic. title: cleanup.policy required: - source - value compression_type: type: object description: compression.type value, source and synonyms properties: source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config synonyms: type: array description: Configuration synonyms items: type: object properties: name: type: string description: Synonym name source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config value: type: string description: Synonym value required: - name - source - value value: type: string description: Specify the final compression type for a given topic. This configuration accepts the standard compression codecs ('gzip', 'snappy', 'lz4', 'zstd'). It additionally accepts 'uncompressed' which is equivalent to no compression; and 'producer' which means retain the original compression codec set by the producer. title: compression.type enum: - snappy - gzip - lz4 - producer - uncompressed - zstd required: - source - value delete_retention_ms: type: object description: delete.retention.ms value, source and synonyms properties: source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config synonyms: type: array description: Configuration synonyms items: type: object properties: name: type: string description: Synonym name source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config value: type: integer description: Synonym value required: - name - source - value value: type: integer minimum: 0 description: The amount of time to retain delete tombstone markers for log compacted topics. This setting also gives a bound on the time in which a consumer must complete a read if they begin from offset 0 to ensure that they get a valid snapshot of the final stage (otherwise delete tombstones may be collected before they complete their scan). title: delete.retention.ms required: - source - value diskless_enable: type: object description: diskless.enable value, source and synonyms properties: source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config synonyms: type: array description: Configuration synonyms items: type: object properties: name: type: string description: Synonym name source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config value: type: boolean description: Synonym value required: - name - source - value value: type: boolean description: Indicates whether diskless should be enabled. This is only available for BYOC services with Diskless feature enabled. title: diskless.enable required: - source - value file_delete_delay_ms: type: object description: file.delete.delay.ms value, source and synonyms properties: source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config synonyms: type: array description: Configuration synonyms items: type: object properties: name: type: string description: Synonym name source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config value: type: integer description: Synonym value required: - name - source - value value: type: integer minimum: 0 description: The time to wait before deleting a file from the filesystem. title: file.delete.delay.ms required: - source - value flush_messages: type: object description: flush.messages value, source and synonyms properties: source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config synonyms: type: array description: Configuration synonyms items: type: object properties: name: type: string description: Synonym name source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config value: type: integer description: Synonym value required: - name - source - value value: type: integer minimum: 0 description: This setting allows specifying an interval at which we will force an fsync of data written to the log. For example if this was set to 1 we would fsync after every message; if it were 5 we would fsync after every five messages. In general we recommend you not set this and use replication for durability and allow the operating system's background flush capabilities as it is more efficient. title: flush.messages required: - source - value flush_ms: type: object description: flush.ms value, source and synonyms properties: source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config synonyms: type: array description: Configuration synonyms items: type: object properties: name: type: string description: Synonym name source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config value: type: integer description: Synonym value required: - name - source - value value: type: integer minimum: 0 description: This setting allows specifying a time interval at which we will force an fsync of data written to the log. For example if this was set to 1000 we would fsync after 1000 ms had passed. In general we recommend you not set this and use replication for durability and allow the operating system's background flush capabilities as it is more efficient. title: flush.ms required: - source - value index_interval_bytes: type: object description: index.interval.bytes value, source and synonyms properties: source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config synonyms: type: array description: Configuration synonyms items: type: object properties: name: type: string description: Synonym name source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config value: type: integer description: Synonym value required: - name - source - value value: type: integer minimum: 0 description: This setting controls how frequently Kafka adds an index entry to its offset index. The default setting ensures that we index a message roughly every 4096 bytes. More indexing allows reads to jump closer to the exact position in the log but makes the index larger. You probably don't need to change this. title: index.interval.bytes required: - source - value local_retention_bytes: type: object description: local.retention.bytes value, source and synonyms properties: source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config synonyms: type: array description: Configuration synonyms items: type: object properties: name: type: string description: Synonym name source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config value: type: integer description: Synonym value required: - name - source - value value: type: integer description: This configuration controls the maximum bytes tiered storage will retain segment files locally before it will discard old log segments to free up space. If set to -2, the limit is equal to overall retention time. If set to -1, no limit is applied but it's possible only if overall retention is also -1. title: local.retention.bytes required: - source - value local_retention_ms: type: object description: local.retention.ms value, source and synonyms properties: source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config synonyms: type: array description: Configuration synonyms items: type: object properties: name: type: string description: Synonym name source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config value: type: integer description: Synonym value required: - name - source - value value: type: integer description: This configuration controls the maximum time tiered storage will retain segment files locally before it will discard old log segments to free up space. If set to -2, the time limit is equal to overall retention time. If set to -1, no time limit is applied but it's possible only if overall retention is also -1. title: local.retention.ms required: - source - value max_compaction_lag_ms: type: object description: max.compaction.lag.ms value, source and synonyms properties: source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config synonyms: type: array description: Configuration synonyms items: type: object properties: name: type: string description: Synonym name source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config value: type: integer description: Synonym value required: - name - source - value value: type: integer minimum: 0 description: The maximum time a message will remain ineligible for compaction in the log. Only applicable for logs that are being compacted. title: max.compaction.lag.ms required: - source - value max_message_bytes: type: object description: max.message.bytes value, source and synonyms properties: source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config synonyms: type: array description: Configuration synonyms items: type: object properties: name: type: string description: Synonym name source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config value: type: integer description: Synonym value required: - name - source - value value: type: integer minimum: 0 description: The largest record batch size allowed by Kafka (after compression if compression is enabled). If this is increased and there are consumers older than 0.10.2, the consumers' fetch size must also be increased so that the they can fetch record batches this large. In the latest message format version, records are always grouped into batches for efficiency. In previous message format versions, uncompressed records are not grouped into batches and this limit only applies to a single record in that case. title: max.message.bytes required: - source - value message_downconversion_enable: type: object description: message.downconversion.enable value, source and synonyms properties: source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config synonyms: type: array description: Configuration synonyms items: type: object properties: name: type: string description: Synonym name source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config value: type: boolean description: Synonym value required: - name - source - value value: type: boolean description: This configuration controls whether down-conversion of message formats is enabled to satisfy consume requests. When set to false, broker will not perform down-conversion for consumers expecting an older message format. The broker responds with UNSUPPORTED_VERSION error for consume requests from such older clients. This configuration does not apply to any message format conversion that might be required for replication to followers. title: message.downconversion.enable required: - source - value message_format_version: type: object description: message.format.version value, source and synonyms properties: source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config synonyms: type: array description: Configuration synonyms items: type: object properties: name: type: string description: Synonym name source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config value: type: string description: Synonym value required: - name - source - value value: type: string description: 'Specify the message format version the broker will use to append messages to the logs. The value should be a valid ApiVersion. Some examples are: 0.8.2, 0.9.0.0, 0.10.0, check ApiVersion for more details. By setting a particular message format version, the user is certifying that all the existing messages on disk are smaller or equal than the specified version. Setting this value incorrectly will cause consumers with older versions to break as they will receive messages with a format that they don''t understand. Deprecated in Kafka 4.0+: this configuration is removed and any supplied value will be ignored; for services upgraded to 4.0+, the returned value may be ''None''.' title: message.format.version enum: - 0.8.0 - 0.8.1 - 0.8.2 - 0.9.0 - 0.10.0 - 0.10.0-IV0 - 0.10.0-IV1 - 0.10.1 - 0.10.1-IV0 - 0.10.1-IV1 - 0.10.1-IV2 - 0.10.2 - 0.10.2-IV0 - 0.11.0 - 0.11.0-IV0 - 0.11.0-IV1 - 0.11.0-IV2 - '1.0' - 1.0-IV0 - '1.1' - 1.1-IV0 - '2.0' - 2.0-IV0 - 2.0-IV1 - '2.1' - 2.1-IV0 - 2.1-IV1 - 2.1-IV2 - '2.2' - 2.2-IV0 - 2.2-IV1 - '2.3' - 2.3-IV0 - 2.3-IV1 - '2.4' - 2.4-IV0 - 2.4-IV1 - '2.5' - 2.5-IV0 - '2.6' - 2.6-IV0 - '2.7' - 2.7-IV0 - 2.7-IV1 - 2.7-IV2 - '2.8' - 2.8-IV0 - 2.8-IV1 - '3.0' - 3.0-IV0 - 3.0-IV1 - '3.1' - 3.1-IV0 - '3.2' - 3.2-IV0 - '3.3' - 3.3-IV0 - 3.3-IV1 - 3.3-IV2 - 3.3-IV3 - '3.4' - 3.4-IV0 - '3.5' - 3.5-IV0 - 3.5-IV1 - 3.5-IV2 - '3.6' - 3.6-IV0 - 3.6-IV1 - 3.6-IV2 - '3.7' - 3.7-IV0 - 3.7-IV1 - 3.7-IV2 - 3.7-IV3 - 3.7-IV4 - '3.8' - 3.8-IV0 - '3.9' - 3.9-IV0 - 3.9-IV1 - '4.0' - 4.0-IV0 - '4.1' - 4.1-IV0 - '4.2' - 4.2-IV0 - None required: - source - value message_timestamp_after_max_ms: type: object description: message.timestamp.after.max.ms value, source and synonyms properties: source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config synonyms: type: array description: Configuration synonyms items: type: object properties: name: type: string description: Synonym name source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config value: type: integer description: Synonym value required: - name - source - value value: type: integer minimum: 0 description: The maximum difference allowed between the timestamp when a broker receives a message and the timestamp specified in the message. If message.timestamp.type=CreateTime, a message will be rejected if the difference in timestamp exceeds this threshold. Applies only for messages with timestamps later than the broker's timestamp. title: message.timestamp.after.max.ms required: - source - value message_timestamp_before_max_ms: type: object description: message.timestamp.before.max.ms value, source and synonyms properties: source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config synonyms: type: array description: Configuration synonyms items: type: object properties: name: type: string description: Synonym name source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config value: type: integer description: Synonym value required: - name - source - value value: type: integer minimum: 0 description: The maximum difference allowed between the timestamp when a broker receives a message and the timestamp specified in the message. If message.timestamp.type=CreateTime, a message will be rejected if the difference in timestamp exceeds this threshold. Applies only for messages with timestamps earlier than the broker's timestamp. title: message.timestamp.before.max.ms required: - source - value message_timestamp_difference_max_ms: type: object description: message.timestamp.difference.max.ms value, source and synonyms properties: source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config synonyms: type: array description: Configuration synonyms items: type: object properties: name: type: string description: Synonym name source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config value: type: integer description: Synonym value required: - name - source - value value: type: integer minimum: 0 description: The maximum difference allowed between the timestamp when a broker receives a message and the timestamp specified in the message. If message.timestamp.type=CreateTime, a message will be rejected if the difference in timestamp exceeds this threshold. This configuration is ignored if message.timestamp.type=LogAppendTime. title: message.timestamp.difference.max.ms required: - source - value message_timestamp_type: type: object description: message.timestamp.type value, source and synonyms properties: source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config synonyms: type: array description: Configuration synonyms items: type: object properties: name: type: string description: Synonym name source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config value: type: string description: Synonym value required: - name - source - value value: type: string description: Define whether the timestamp in the message is message create time or log append time. title: message.timestamp.type enum: - CreateTime - LogAppendTime required: - source - value min_cleanable_dirty_ratio: type: object description: min.cleanable.dirty.ratio value, source and synonyms properties: source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config synonyms: type: array description: Configuration synonyms items: type: object properties: name: type: string description: Synonym name source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config value: type: number description: Synonym value required: - name - source - value value: type: number minimum: 0 maximum: 1 description: 'This configuration controls how frequently the log compactor will attempt to clean the log (assuming log compaction is enabled). By default we will avoid cleaning a log where more than 50% of the log has been compacted. This ratio bounds the maximum space wasted in the log by duplicates (at 50% at most 50% of the log could be duplicates). A higher ratio will mean fewer, more efficient cleanings but will mean more wasted space in the log. If the max.compaction.lag.ms or the min.compaction.lag.ms configurations are also specified, then the log compactor considers the log to be eligible for compaction as soon as either: (i) the dirty ratio threshold has been met and the log has had dirty (uncompacted) records for at least the min.compaction.lag.ms duration, or (ii) if the log has had dirty (uncompacted) records for at most the max.compaction.lag.ms period.' title: min.cleanable.dirty.ratio required: - source - value min_compaction_lag_ms: type: object description: min.compaction.lag.ms value, source and synonyms properties: source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config synonyms: type: array description: Configuration synonyms items: type: object properties: name: type: string description: Synonym name source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config value: type: integer description: Synonym value required: - name - source - value value: type: integer minimum: 0 description: The minimum time a message will remain uncompacted in the log. Only applicable for logs that are being compacted. title: min.compaction.lag.ms required: - source - value min_insync_replicas: type: object description: min.insync.replicas value, source and synonyms properties: source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config synonyms: type: array description: Configuration synonyms items: type: object properties: name: type: string description: Synonym name source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config value: type: integer description: Synonym value required: - name - source - value value: type: integer minimum: 1 description: When a producer sets acks to 'all' (or '-1'), this configuration specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful. If this minimum cannot be met, then the producer will raise an exception (either NotEnoughReplicas or NotEnoughReplicasAfterAppend). When used together, min.insync.replicas and acks allow you to enforce greater durability guarantees. A typical scenario would be to create a topic with a replication factor of 3, set min.insync.replicas to 2, and produce with acks of 'all'. This will ensure that the producer raises an exception if a majority of replicas do not receive a write. title: min.insync.replicas required: - source - value preallocate: type: object description: preallocate value, source and synonyms properties: source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config synonyms: type: array description: Configuration synonyms items: type: object properties: name: type: string description: Synonym name source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config value: type: boolean description: Synonym value required: - name - source - value value: type: boolean description: True if we should preallocate the file on disk when creating a new log segment. title: preallocate required: - source - value remote_storage_enable: type: object description: remote.storage.enable value, source and synonyms properties: source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config synonyms: type: array description: Configuration synonyms items: type: object properties: name: type: string description: Synonym name source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config value: type: boolean description: Synonym value required: - name - source - value value: type: boolean description: Indicates whether tiered storage should be enabled. This is only available for services with Tiered Storage feature enabled. title: remote.storage.enable required: - source - value retention_bytes: type: object description: retention.bytes value, source and synonyms properties: source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config synonyms: type: array description: Configuration synonyms items: type: object properties: name: type: string description: Synonym name source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config value: type: integer description: Synonym value required: - name - source - value value: type: integer description: This configuration controls the maximum size a partition (which consists of log segments) can grow to before we will discard old log segments to free up space if we are using the 'delete' retention policy. By default there is no size limit only a time limit. Since this limit is enforced at the partition level, multiply it by the number of partitions to compute the topic retention in bytes. title: retention.bytes required: - source - value retention_ms: type: object description: retention.ms value, source and synonyms properties: source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config synonyms: type: array description: Configuration synonyms items: type: object properties: name: type: string description: Synonym name source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config value: type: integer description: Synonym value required: - name - source - value value: type: integer description: This configuration controls the maximum time we will retain a log before we will discard old log segments to free up space if we are using the 'delete' retention policy. This represents an SLA on how soon consumers must read their data. If set to -1, no time limit is applied. title: retention.ms required: - source - value segment_bytes: type: object description: segment.bytes value, source and synonyms properties: source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config synonyms: type: array description: Configuration synonyms items: type: object properties: name: type: string description: Synonym name source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config value: type: integer description: Synonym value required: - name - source - value value: type: integer minimum: 14 description: This configuration controls the segment file size for the log. Retention and cleaning is always done a file at a time so a larger segment size means fewer files but less granular control over retention. Setting this to a very low value has consequences, and the Aiven management plane ignores values less than 10 megabytes. title: segment.bytes required: - source - value segment_index_bytes: type: object description: segment.index.bytes value, source and synonyms properties: source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config synonyms: type: array description: Configuration synonyms items: type: object properties: name: type: string description: Synonym name source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config value: type: integer description: Synonym value required: - name - source - value value: type: integer minimum: 0 description: This configuration controls the size of the index that maps offsets to file positions. We preallocate this index file and shrink it only after log rolls. You generally should not need to change this setting. title: segment.index.bytes required: - source - value segment_jitter_ms: type: object description: segment.jitter.ms value, source and synonyms properties: source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config synonyms: type: array description: Configuration synonyms items: type: object properties: name: type: string description: Synonym name source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config value: type: integer description: Synonym value required: - name - source - value value: type: integer minimum: 0 description: The maximum random jitter subtracted from the scheduled segment roll time to avoid thundering herds of segment rolling title: segment.jitter.ms required: - source - value segment_ms: type: object description: segment.ms value, source and synonyms properties: source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config synonyms: type: array description: Configuration synonyms items: type: object properties: name: type: string description: Synonym name source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config value: type: integer description: Synonym value required: - name - source - value value: type: integer minimum: 1 description: This configuration controls the period of time after which Kafka will force the log to roll even if the segment file isn't full to ensure that retention can delete or compact old data. Setting this to a very low value has consequences, and the Aiven management plane ignores values less than 10 seconds. title: segment.ms required: - source - value unclean_leader_election_enable: type: object description: unclean.leader.election.enable value, source and synonyms properties: source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config synonyms: type: array description: Configuration synonyms items: type: object properties: name: type: string description: Synonym name source: type: string description: Source of the Kafka topic configuration entry enum: - unknown_config - topic_config - dynamic_broker_config - dynamic_default_broker_config - static_broker_config - default_config - dynamic_broker_logger_config value: type: boolean description: Synonym value required: - name - source - value value: type: boolean description: Indicates whether to enable replicas not in the ISR set to be elected as leader as a last resort, even though doing so may result in data loss. title: unclean.leader.election.enable required: - source - value min_insync_replicas: type: integer minimum: 1 description: When a producer sets acks to 'all' (or '-1'), this configuration specifies the minimum number of replicas that must acknowledge a write for the write to be considered successful. If this minimum cannot be met, then the producer will raise an exception (either NotEnoughReplicas or NotEnoughReplicasAfterAppend). When used together, min.insync.replicas and acks allow you to enforce greater durability guarantees. A typical scenario would be to create a topic with a replication factor of 3, set min.insync.replicas to 2, and produce with acks of 'all'. This will ensure that the producer raises an exception if a majority of replicas do not receive a write. title: 'DEPRECATED: use config.min_insync_replicas' owner_user_group_id: type: string minLength: 1 maxLength: 36 description: The user group that owns this topic partitions: type: array description: Topic partitions items: type: object properties: consumer_groups: type: array description: List of Kafka consumer groups items: type: object properties: group_name: type: string description: consumer group offset: type: integer minimum: 0 description: Latest partition message offset required: - group_name - offset earliest_offset: type: integer description: Earliest partition message offset isr: type: integer minimum: 0 description: Number of In Sync Replicas (ISR) latest_offset: type: integer description: Latest partition message offset partition: type: integer description: Partition number remote_size: type: integer minimum: 0 description: Size of tiered data from partition in bytes size: type: integer minimum: 0 description: Size of partition in bytes required: - consumer_groups - earliest_offset - isr - latest_offset - partition - size replication: type: integer minimum: 1 description: Number of replicas retention_bytes: type: integer description: This configuration controls the maximum size a partition (which consists of log segments) can grow to before we will discard old log segments to free up space if we are using the 'delete' retention policy. By default there is no size limit only a time limit. Since this limit is enforced at the partition level, multiply it by the number of partitions to compute the topic retention in bytes. title: 'DEPRECATED: use config.retention_bytes' retention_hours: type: integer maximum: 2562047788015 description: 'DEPRECATED: use config.retention_ms' state: type: string description: Topic state enum: - ACTIVE - CONFIGURING - DELETING tags: type: array minItems: 0 maxItems: 25 description: Topic tags items: type: object properties: key: type: string minLength: 1 maxLength: 64 description: Tag key value: type: string minLength: 0 maxLength: 256 description: Tag value required: - key - value topic_description: type: string minLength: 1 maxLength: 256 description: Topic description topic_name: type: string minLength: 1 maxLength: 249 description: Topic name required: - cleanup_policy - config - min_insync_replicas - owner_user_group_id - partitions - replication - retention_bytes - retention_hours - state - tags - topic_description - topic_name required: - topic ServiceKafkaConnectGetConnectorStatusResponse: type: object description: ServiceKafkaConnectGetConnectorStatusResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request status: type: object description: Connector status information properties: state: type: string description: Current status of the connector enum: - FAILED - PAUSED - RUNNING - STOPPED - UNASSIGNED tasks: type: array description: List of tasks currently running for the connector items: type: object properties: id: type: integer description: Task identifier state: type: string description: Current status of the task enum: - FAILED - PAUSED - RUNNING - STOPPED - UNASSIGNED trace: type: string description: Task error information required: - id - state - trace required: - state - tasks required: - status ServiceKafkaTieredStorageSummaryResponse: type: object description: ServiceKafkaTieredStorageSummaryResponse properties: current_cost: type: string description: The current cost in USD of tiered storage since the beginning of the billing period errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status forecasted_cost: type: string description: The forecasted cost in USD of tiered storage in the billing period forecasted_rate: type: string description: The rate on GBs/hour used to calculate the forecasted cost message: type: string description: Printable result of the request storage_usage_history: type: object description: History of usage and cumulative costs in the billing period properties: hourly: type: array description: History by hour items: type: object properties: estimated_cost: type: string description: The estimated cost in USD of tiered storage for this hour hour_start: type: string maxLength: 36 description: Timestamp in ISO 8601 format, always in UTC peak_stored_bytes: type: integer minimum: 0 description: Peak bytes stored on object storage at this hour required: - hour_start - peak_stored_bytes required: - hourly total_storage_usage: type: integer minimum: 0 description: Total storage usage by tiered storage, in bytes required: - current_cost - forecasted_cost - storage_usage_history - total_storage_usage ServiceKafkaQuotaCreateResponse: type: object description: ServiceKafkaQuotaCreateResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request ServiceSchemaRegistrySubjectVersionsGetResponse: type: object description: ServiceSchemaRegistrySubjectVersionsGetResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request versions: type: array description: List of available versions for a Schema Registry subject items: type: integer required: - versions ServiceSchemaRegistryAclListResponse: type: object description: ServiceSchemaRegistryAclListResponse properties: acl: type: array description: List of Schema Registry ACL entries items: type: object properties: id: type: string maxLength: 40 description: ID permission: type: string description: ACL entry for Schema Registry enum: - schema_registry_read - schema_registry_write resource: type: string minLength: 1 maxLength: 249 description: Schema Registry ACL entry resource name pattern username: type: string minLength: 1 maxLength: 64 description: Username required: - permission - resource - username errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request required: - acl ServiceKafkaTopicMessageProduceRequestBody: type: object description: ServiceKafkaTopicMessageProduceRequestBody properties: format: type: string description: The format of the content. enum: - binary - json - avro - protobuf - jsonschema key_schema: type: string minLength: 18 maxLength: 2048 description: Full schema encoded as a string (e.g. JSON serialized for Avro data) key_schema_id: type: integer minimum: 1 maximum: 50000 description: ID returned by a previous request using the same schema. This ID corresponds to the ID of the schema in the registry. records: type: array maxItems: 32 description: List of records to produce to the topic items: type: object properties: key: type: object description: Key for the produced record properties: {} partition: type: integer minimum: 0 maximum: 10000 description: Optionally specify the partition where to produce the record value: type: object description: Value for the produced record properties: {} value_schema: type: string minLength: 18 maxLength: 2048 description: Full schema encoded as a string (e.g. JSON serialized for Avro data) value_schema_id: type: integer minimum: 1 maximum: 50000 description: ID returned by a previous request using the same schema. This ID corresponds to the ID of the schema in the registry. required: - format - records ServiceKafkaNativeAclAddResponse: type: object description: ServiceKafkaNativeAclAddResponse properties: acl: type: object description: Kafka-native ACL entry for Kafka service properties: host: type: string minLength: 0 maxLength: 256 description: the host or * for all hosts id: type: string maxLength: 40 description: ID operation: type: string description: Kafka ACL operation represents an operation which an ACL grants or denies permission to perform enum: - All - Alter - AlterConfigs - ClusterAction - Create - CreateTokens - Delete - Describe - DescribeConfigs - DescribeTokens - IdempotentWrite - Read - Write pattern_type: type: string description: Kafka ACL pattern type of resource name enum: - LITERAL - PREFIXED permission_type: type: string description: Kafka ACL permission type enum: - ALLOW - DENY principal: type: string minLength: 0 maxLength: 256 description: principal is in 'principalType:name' format resource_name: type: string minLength: 0 maxLength: 256 description: Resource pattern used to match specified resources resource_type: type: string description: Kafka ACL resource type represents a type of resource which an ACL can be applied to enum: - Cluster - DelegationToken - Group - Topic - TransactionalId - User required: - host - id - operation - pattern_type - permission_type - principal - resource_name - resource_type errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request required: - acl ServiceKafkaTieredStorageStorageUsageByTopicResponse: type: object description: ServiceKafkaTieredStorageStorageUsageByTopicResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request storage_usage: type: object description: Storage usage by tiered storage by topics properties: {} required: - storage_usage ServiceKafkaTopicDeleteResponse: type: object description: ServiceKafkaTopicDeleteResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request ServiceKafkaNativeAclDeleteResponse: type: object description: ServiceKafkaNativeAclDeleteResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request ServiceKafkaConnectResumeConnectorResponse: type: object description: ServiceKafkaConnectResumeConnectorResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request ServiceKafkaTopicCreateResponse: type: object description: ServiceKafkaTopicCreateResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request ServiceSchemaRegistrySchemaGetResponse: type: object description: ServiceSchemaRegistrySchemaGetResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status message: type: string description: Printable result of the request ServiceKafkaTopicMessageProduceResponse: type: object description: ServiceKafkaTopicMessageProduceResponse properties: errors: type: array description: List of errors occurred during request processing items: type: object properties: message: type: string description: Printable error message more_info: type: string description: URL to the documentation of the error status: type: integer description: HTTP error status code required: - message - status key_schema_id: type: integer description: The ID for the schema used to produce keys, or null if keys were not used message: type: string description: Printable result of the request offsets: type: array description: List of offsets for the produced record items: type: object properties: error: type: string description: An error message describing why the operation failed, or null if it succeeded error_code: type: integer description: An error code classifying the reason this operation failed, or null if it succeeded. 1 = Non-retriable Kafka exception, 2 = Retriable Kafka exception; the message might be sent successfully if retried offset: type: integer description: Offset of the message, or null if publishing the message failed partition: type: integer description: Partition the message was published to, or null if publishing the message failed value_schema_id: type: integer description: The ID for the schema used to produce values parameters: servicekafkaquotadelete_client-id: in: query name: client-id description: Client ID. schema: type: string required: false servicekafkaquotadelete_user: in: query name: user description: Username. schema: type: string required: false project: in: path name: project description: Project name schema: type: string required: true subject_name: in: path name: subject_name description: Subject name schema: type: string required: true servicekafkaquotadescribe_client-id: in: query name: client-id description: Client ID. schema: type: string required: false topic_name: in: path name: topic_name description: Kafka topic name schema: type: string required: true connector_name: in: path name: connector_name description: Connector name schema: type: string required: true servicekafkaquotadescribe_user: in: query name: user description: Username. schema: type: string required: false service_name: in: path name: service_name description: Service name schema: type: string required: true version_id: in: path name: version_id description: Version Id schema: type: string required: true kafka_acl_id: in: path name: kafka_acl_id description: Kafka ACL ID schema: type: string required: true schema_id: in: path name: schema_id description: Schema Id schema: type: string required: true task_id: in: path name: task_id description: Service task schema: type: string required: true schema_registry_acl_id: in: path name: schema_registry_acl_id description: Kafka Schema Registry ACL ID schema: type: string required: true securitySchemes: tokenAuth: description: 'Header should be of the format `authorization: aivenv1 `. Tokens can be obtained from [your Aiven profile page](https://console.aiven.io/profile/auth)' scheme: bearer type: http oauth2: type: oauth2 description: OAuth2 security scheme flows: authorizationCode: authorizationUrl: https://console.aiven.io/oauth/authorize tokenUrl: https://api.aiven.io/v1/oauth2/token scopes: all: Provide full access to the API accounts: Allow enumerating and reading accounts configuration accounts:read: Allow modifying account configuration accounts:write: Provides full access to authentication related API authentication: Provides full access to authentication related API authentication:read: Allow reading authentication related configuration on resources (user profile, accounts) authentication:write: Allow modifying authentication related configurations on resources (user profile, accounts) billing: Provide full access to billing APIs billing:read: Allow reading billing information and configuration billing:write: Allow writing billing configuration payments: Provide full access to payment method APIs payments:read: Allow reading the payment method configurations payments:write: Allows writing payment method configuration privatelink: Provide full access to private link APIs privatelink:read: Allow enumerating and reading private link items and configurations privatelink:write: Allow writing (creating, modifying, deleting) private link items projects: Provide full access to projects APIs projects:read: Allow enumerating projects and reading their configuration projects:write: Allow writing (creating, modifying, deleting) projects scim: Provide full access to SCIM operations scim:read: Allow reading SCIM endpoints scim:write: Allow writing (modifying) SCIM endpoints services: Provide full access to services APIs services:read: Allow enumerating services and reading their configuration services:write: Allow writing (creating, modifying, deleting) services static_ips: Provide full access to static IPs APIs static_ips:read: Allow enumerating and reading static IP items and configurations static_ips:write: Allow writing (creating, modifying, deleting) static IP items tickets: Provide full access to support ticket APIs tickets:read: Allow enumerating and reading support tickets tickets:write: Allow writing (creating, modifying) support tickets user: Provide full access to user profile APIs user:read: Allow reading user profile and configuration user:write: Allow writing (modifying) user profile and configuration externalDocs: description: Aiven CLI client url: https://github.com/aiven/aiven-client