How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Aiven Service:_Kafka API

The Service:_Kafka API from Aiven — 34 operation(s) for service:_kafka.

Aiven Service:_Kafka API is one of 34 APIs that Aiven publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 8 JSON Schema definitions.

Tagged areas include Service:_Kafka. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and 8 JSON Schemas.

This API exposes 49 operations across 34 paths, and defines 63 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, https://api.aiven.io/v1.

49 operations 34 paths 63 schemas 8 DELETE22 GET15 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://api.aiven.io/v1
Authentication
HTTP Bearer, OAuth 2.0
Resource Areas
1

Authentication & Security 2

Aiven Service:_Kafka API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (tokenAuth). It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 34 scopes.

  • tokenAuth — Header should be of the format authorization: aivenv1 . Tokens can be obtained from [your Aiven profile page](https://console.aiven.io/profile/auth)
  • oauth2 — OAuth2 security scheme

Paths & Operations 49

Across 34 paths, the API surfaces 49 operations — 8 DELETE, 22 GET, 15 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Service:_Kafka 49
POST
/project/{project}/service/{service_name}/acl
Add Aiven Kafka ACL entry
ServiceKafkaAclAdd 2 params body → 200400
GET
/project/{project}/service/{service_name}/acl
List Aiven ACL entries for Kafka service
ServiceKafkaAclList 2 params → 200404
DELETE
/project/{project}/service/{service_name}/acl/{kafka_acl_id}
Delete a Kafka ACL entry
ServiceKafkaAclDelete 3 params → 200404
POST
/project/{project}/service/{service_name}/connectors
Create a Kafka Connect connector
ServiceKafkaConnectCreateConnector 2 params body → 200
GET
/project/{project}/service/{service_name}/connectors
Lists Kafka connectors
ServiceKafkaConnectList 2 params → 200
DELETE
/project/{project}/service/{service_name}/connectors/{connector_name}
Delete Kafka Connect connector
ServiceKafkaConnectDeleteConnector 3 params → 200
PUT
/project/{project}/service/{service_name}/connectors/{connector_name}
Edit Kafka Connect connector
ServiceKafkaConnectEditConnector 3 params body → 200
GET
/project/{project}/service/{service_name}/available-connectors
Get available Kafka Connect connectors
ServiceKafkaConnectGetAvailableConnectors 2 params → 200
GET
/project/{project}/service/{service_name}/connector-plugins/{connector_name}/configuration
Get Kafka Connect connector configuration schema
ServiceKafkaConnectGetConnectorConfiguration 3 params → 200
GET
/project/{project}/service/{service_name}/connectors/{connector_name}/status
Get a Kafka Connect Connector status
ServiceKafkaConnectGetConnectorStatus 3 params → 200
POST
/project/{project}/service/{service_name}/connectors/{connector_name}/pause
Pause a Kafka Connect Connector
ServiceKafkaConnectPauseConnector 3 params → 200
POST
/project/{project}/service/{service_name}/connectors/{connector_name}/restart
Restart a Kafka Connect Connector
ServiceKafkaConnectRestartConnector 3 params → 200
POST
/project/{project}/service/{service_name}/connectors/{connector_name}/tasks/{task_id}/restart
Restart a Kafka Connect Connector task
ServiceKafkaConnectRestartConnectorTask 4 params → 200
POST
/project/{project}/service/{service_name}/connectors/{connector_name}/resume
Resume a Kafka Connect Connector
ServiceKafkaConnectResumeConnector 3 params → 200
POST
/project/{project}/service/{service_name}/connectors/{connector_name}/stop
Stop a Kafka Connect Connector
ServiceKafkaConnectStopConnector 3 params → 200
POST
/project/{project}/service/{service_name}/kafka/acl
Add a Kafka-native ACL entry
ServiceKafkaNativeAclAdd 2 params body → 200400409
GET
/project/{project}/service/{service_name}/kafka/acl
List Kafka-native ACL entries
ServiceKafkaNativeAclList 2 params → 200404409
DELETE
/project/{project}/service/{service_name}/kafka/acl/{kafka_acl_id}
Delete a Kafka-native ACL entry
ServiceKafkaNativeAclDelete 3 params → 200404
GET
/project/{project}/service/{service_name}/kafka/acl/{kafka_acl_id}
Get single Kafka-native ACL entry
ServiceKafkaNativeAclGet 3 params → 200404
POST
/project/{project}/service/{service_name}/quota
Create Kafka quota
ServiceKafkaQuotaCreate 2 params body → 200
DELETE
/project/{project}/service/{service_name}/quota
Delete Kafka quota
ServiceKafkaQuotaDelete 4 params → 200
GET
/project/{project}/service/{service_name}/quota
List Kafka quotas
ServiceKafkaQuotaList 2 params → 200
GET
/project/{project}/service/{service_name}/quota/describe
Describe Specific Kafka quotas
ServiceKafkaQuotaDescribe 4 params → 200
GET
/project/{project}/service/{service_name}/kafka/tiered-storage/storage-usage/by-topic
Get the Kafka tiered storage object storage usage by topic
ServiceKafkaTieredStorageStorageUsageByTopic 2 params → 200
GET
/project/{project}/service/{service_name}/kafka/tiered-storage/storage-usage/total
Get the Kafka tiered storage total object storage usage
ServiceKafkaTieredStorageStorageUsageTotal 2 params → 200
GET
/project/{project}/service/{service_name}/kafka/tiered-storage/summary
Get the Kafka tiered storage summary
ServiceKafkaTieredStorageSummary 2 params → 200
POST
/project/{project}/service/{service_name}/topic
Create a Kafka topic
ServiceKafkaTopicCreate 2 params body → 200400409503
GET
/project/{project}/service/{service_name}/topic
Get Kafka topic list
ServiceKafkaTopicList 2 params → 200
DELETE
/project/{project}/service/{service_name}/topic/{topic_name}
Delete a Kafka topic
ServiceKafkaTopicDelete 3 params → 200404409503
GET
/project/{project}/service/{service_name}/topic/{topic_name}
Get Kafka topic info
ServiceKafkaTopicGet 3 params → 200404409
PUT
/project/{project}/service/{service_name}/topic/{topic_name}
Update a Kafka topic
ServiceKafkaTopicUpdate 3 params body → 200400404409503
POST
/project/{project}/service/{service_name}/kafka/rest/topics/{topic_name}/messages
List kafka topic messages
ServiceKafkaTopicMessageList 3 params body → 200
POST
/project/{project}/service/{service_name}/kafka/rest/topics/{topic_name}/produce
Produce message into a kafka topic
ServiceKafkaTopicMessageProduce 3 params body → 200
POST
/project/{project}/service/{service_name}/kafka/schema-registry/acl
Add a Schema Registry ACL entry
ServiceSchemaRegistryAclAdd 2 params body → 200400
GET
/project/{project}/service/{service_name}/kafka/schema-registry/acl
List Schema Registry ACL entries
ServiceSchemaRegistryAclList 2 params → 200
DELETE
/project/{project}/service/{service_name}/kafka/schema-registry/acl/{schema_registry_acl_id}
Delete a Schema Registry ACL entry
ServiceSchemaRegistryAclDelete 3 params → 200
POST
/project/{project}/service/{service_name}/kafka/schema/compatibility/subjects/{subject_name}/versions/{version_id}
Check compatibility of schema in Schema Registry
ServiceSchemaRegistryCompatibility 4 params body → 200
GET
/project/{project}/service/{service_name}/kafka/schema/config
Get global configuration for Schema Registry
ServiceSchemaRegistryGlobalConfigGet 2 params → 200
PUT
/project/{project}/service/{service_name}/kafka/schema/config
Edit global configuration for Schema Registry
ServiceSchemaRegistryGlobalConfigPut 2 params body → 200
GET
/project/{project}/service/{service_name}/kafka/schema/schemas/ids/{schema_id}
Get schema in Schema Registry
ServiceSchemaRegistrySchemaGet 3 params → 200
GET
/project/{project}/service/{service_name}/kafka/schema/config/{subject_name}
Get configuration for Schema Registry subject
ServiceSchemaRegistrySubjectConfigGet 3 params → 200
PUT
/project/{project}/service/{service_name}/kafka/schema/config/{subject_name}
Edit configuration for Schema Registry subject
ServiceSchemaRegistrySubjectConfigPut 3 params body → 200
DELETE
/project/{project}/service/{service_name}/kafka/schema/subjects/{subject_name}
Delete Schema Registry subject
ServiceSchemaRegistrySubjectDelete 3 params → 200
DELETE
/project/{project}/service/{service_name}/kafka/schema/subjects/{subject_name}/versions/{version_id}
Delete Schema Registry subject version
ServiceSchemaRegistrySubjectVersionDelete 4 params → 200
GET
/project/{project}/service/{service_name}/kafka/schema/subjects/{subject_name}/versions/{version_id}
Get Schema Registry Subject version
ServiceSchemaRegistrySubjectVersionGet 4 params → 200
POST
/project/{project}/service/{service_name}/kafka/schema/subjects/{subject_name}/versions
Register a new Schema in Schema Registry
ServiceSchemaRegistrySubjectVersionPost 3 params body → 200
GET
/project/{project}/service/{service_name}/kafka/schema/subjects/{subject_name}/versions
Get Schema Registry subject versions
ServiceSchemaRegistrySubjectVersionsGet 3 params → 200
GET
/project/{project}/service/{service_name}/kafka/schema/subjects/{subject_name}/versions/{version_id}/schemadeprecated
DEPRECATED: Get raw schema of a specific version in Schema Registry
ServiceSchemaRegistrySubjectVersionSchemaGet 4 params → 200
GET
/project/{project}/service/{service_name}/kafka/schema/subjects
Lists Schema Registry subjects
ServiceSchemaRegistrySubjects 2 params → 200

Schemas 63

The contract defines 63 schemas that model the data the API accepts and returns. The most detailed are ServiceKafkaTopicCreateRequestBody (11 properties), ServiceKafkaTopicUpdateRequestBody (9 properties), ServiceKafkaTieredStorageSummaryResponse (7 properties), ServiceKafkaNativeAclAddRequestBody (7 properties). Each schema is shown below with its type and property counts.

ServiceKafkaTopicMessageListResponse
object
ServiceKafkaTopicMessageListResponse
3 properties
ServiceKafkaConnectRestartConnectorResponse
object
ServiceKafkaConnectRestartConnectorResponse
2 properties
ServiceSchemaRegistryAclDeleteResponse
object
ServiceSchemaRegistryAclDeleteResponse
3 properties 1 required
ServiceSchemaRegistrySubjectDeleteResponse
object
ServiceSchemaRegistrySubjectDeleteResponse
2 properties
ServiceSchemaRegistryGlobalConfigPutRequestBody
object
ServiceSchemaRegistryGlobalConfigPutRequestBody
1 property 1 required
ServiceSchemaRegistryAclAddRequestBody
object
ServiceSchemaRegistryAclAddRequestBody
3 properties 3 required
ServiceKafkaTopicMessageListRequestBody
object
ServiceKafkaTopicMessageListRequestBody
4 properties 1 required
ServiceKafkaTopicMessageProduceRequestBody
object
ServiceKafkaTopicMessageProduceRequestBody
6 properties 2 required
ServiceSchemaRegistrySubjectVersionSchemaGetResponse
object
ServiceSchemaRegistrySubjectVersionSchemaGetResponse
2 properties
ServiceKafkaTieredStorageStorageUsageTotalResponse
object
ServiceKafkaTieredStorageStorageUsageTotalResponse
3 properties 1 required
ServiceKafkaConnectDeleteConnectorResponse
object
ServiceKafkaConnectDeleteConnectorResponse
2 properties
ServiceKafkaConnectEditConnectorRequestBody
object
ServiceKafkaConnectEditConnectorRequestBody
2 properties 2 required
ServiceKafkaTopicGetResponse
object
ServiceKafkaTopicGetResponse
3 properties 1 required
ServiceKafkaQuotaListResponse
object
ServiceKafkaQuotaListResponse
3 properties 1 required
ServiceKafkaAclAddResponse
object
ServiceKafkaAclAddResponse
3 properties 1 required
ServiceKafkaConnectCreateConnectorResponse
object
ServiceKafkaConnectCreateConnectorResponse
3 properties 1 required
ServiceKafkaConnectCreateConnectorRequestBody
object
ServiceKafkaConnectCreateConnectorRequestBody
2 properties 2 required
ServiceKafkaAclAddRequestBody
object
ServiceKafkaAclAddRequestBody
3 properties 3 required
ServiceKafkaQuotaCreateResponse
object
ServiceKafkaQuotaCreateResponse
2 properties
ServiceKafkaTopicUpdateResponse
object
ServiceKafkaTopicUpdateResponse
2 properties
ServiceSchemaRegistryCompatibilityResponse
object
ServiceSchemaRegistryCompatibilityResponse
4 properties 1 required
ServiceKafkaConnectRestartConnectorTaskResponse
object
ServiceKafkaConnectRestartConnectorTaskResponse
2 properties
ServiceSchemaRegistrySubjectsResponse
object
ServiceSchemaRegistrySubjectsResponse
3 properties 1 required
ServiceKafkaAclListResponse
object
ServiceKafkaAclListResponse
3 properties 1 required
ServiceKafkaConnectEditConnectorResponse
object
ServiceKafkaConnectEditConnectorResponse
3 properties 1 required
ServiceKafkaTieredStorageStorageUsageByTopicResponse
object
ServiceKafkaTieredStorageStorageUsageByTopicResponse
3 properties 1 required
ServiceSchemaRegistrySubjectVersionPostRequestBody
object
ServiceSchemaRegistrySubjectVersionPostRequestBody
3 properties 1 required
ServiceSchemaRegistrySubjectConfigGetResponse
object
ServiceSchemaRegistrySubjectConfigGetResponse
3 properties 1 required
ServiceKafkaConnectStopConnectorResponse
object
ServiceKafkaConnectStopConnectorResponse
2 properties
ServiceKafkaConnectGetAvailableConnectorsResponse
object
ServiceKafkaConnectGetAvailableConnectorsResponse
3 properties 1 required
ServiceSchemaRegistrySubjectVersionDeleteResponse
object
ServiceSchemaRegistrySubjectVersionDeleteResponse
2 properties
ServiceKafkaTopicListResponse
object
ServiceKafkaTopicListResponse
3 properties 1 required
ServiceKafkaTopicUpdateRequestBody
object
ServiceKafkaTopicUpdateRequestBody
9 properties
ServiceSchemaRegistrySubjectVersionPostResponse
object
ServiceSchemaRegistrySubjectVersionPostResponse
3 properties 1 required
ServiceKafkaNativeAclAddRequestBody
object
ServiceKafkaNativeAclAddRequestBody
7 properties 6 required
ServiceSchemaRegistryGlobalConfigGetResponse
object
ServiceSchemaRegistryGlobalConfigGetResponse
3 properties 1 required
ServiceKafkaNativeAclGetResponse
object
ServiceKafkaNativeAclGetResponse
3 properties 1 required
ServiceKafkaTieredStorageSummaryResponse
object
ServiceKafkaTieredStorageSummaryResponse
7 properties 4 required
ServiceSchemaRegistrySubjectVersionGetResponse
object
ServiceSchemaRegistrySubjectVersionGetResponse
3 properties 1 required
ServiceSchemaRegistryCompatibilityRequestBody
object
ServiceSchemaRegistryCompatibilityRequestBody
2 properties 1 required
ServiceKafkaNativeAclListResponse
object
ServiceKafkaNativeAclListResponse
4 properties 2 required
ServiceKafkaConnectPauseConnectorResponse
object
ServiceKafkaConnectPauseConnectorResponse
2 properties
ServiceKafkaTopicCreateResponse
object
ServiceKafkaTopicCreateResponse
2 properties
ServiceKafkaTopicMessageProduceResponse
object
ServiceKafkaTopicMessageProduceResponse
5 properties
ServiceKafkaNativeAclDeleteResponse
object
ServiceKafkaNativeAclDeleteResponse
2 properties
ServiceKafkaQuotaDescribeResponse
object
ServiceKafkaQuotaDescribeResponse
3 properties 1 required
ServiceKafkaConnectGetConnectorConfigurationResponse
object
ServiceKafkaConnectGetConnectorConfigurationResponse
3 properties 1 required
ServiceKafkaConnectResumeConnectorResponse
object
ServiceKafkaConnectResumeConnectorResponse
2 properties
ServiceSchemaRegistrySchemaGetResponse
object
ServiceSchemaRegistrySchemaGetResponse
2 properties
ServiceSchemaRegistrySubjectConfigPutResponse
object
ServiceSchemaRegistrySubjectConfigPutResponse
3 properties 1 required
ServiceKafkaConnectListResponse
object
ServiceKafkaConnectListResponse
4 properties 1 required
ServiceKafkaTopicCreateRequestBody
object
ServiceKafkaTopicCreateRequestBody
11 properties 1 required
ServiceKafkaQuotaCreateRequestBody
object
ServiceKafkaQuotaCreateRequestBody
5 properties
ServiceSchemaRegistrySubjectConfigPutRequestBody
object
ServiceSchemaRegistrySubjectConfigPutRequestBody
1 property 1 required
ServiceKafkaNativeAclAddResponse
object
ServiceKafkaNativeAclAddResponse
3 properties 1 required
ServiceSchemaRegistryAclListResponse
object
ServiceSchemaRegistryAclListResponse
3 properties 1 required
ServiceKafkaConnectGetConnectorStatusResponse
object
ServiceKafkaConnectGetConnectorStatusResponse
3 properties 1 required
ServiceSchemaRegistryGlobalConfigPutResponse
object
ServiceSchemaRegistryGlobalConfigPutResponse
3 properties 1 required
ServiceKafkaAclDeleteResponse
object
ServiceKafkaAclDeleteResponse
3 properties 1 required
ServiceSchemaRegistryAclAddResponse
object
ServiceSchemaRegistryAclAddResponse
3 properties 1 required
ServiceKafkaQuotaDeleteResponse
object
ServiceKafkaQuotaDeleteResponse
2 properties
ServiceSchemaRegistrySubjectVersionsGetResponse
object
ServiceSchemaRegistrySubjectVersionsGetResponse
3 properties 1 required
ServiceKafkaTopicDeleteResponse
object
ServiceKafkaTopicDeleteResponse
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aiven-service-kafka-api-openapi.yml Raw ↑

Other APIs Aiven publishes across the network.

Aiven Account API
Aiven Application_Users API
Aiven Authentication_Methods API
Aiven Billing API
Aiven BillingGroup API
Aiven Cloud_platforms API
Aiven Custom_Cloud API
Aiven Domains API
Aiven Groups API
Aiven Organization_Vpc API
Aiven OrganizationBillingGroup API
Aiven OrganizationEmissions API
Where this information came from

This is an independent, third-party profile of Aiven Service:_Kafka API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.