Aiven · Example Payload

Aiven Create Kafka Service

Example request to provision a managed Apache Kafka cluster on Aiven

Managed Data InfrastructureApache KafkaPostgreSQLOpenSearchClickHouseRedisMySQLOpen SourceCloud DatabaseDBaaSData StreamingData Platform

Aiven Create Kafka Service is an example object payload from Aiven, with 4 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

summarydescriptionrequestresponse

Example Payload

Raw ↑ 
{
  "summary": "Create a managed Apache Kafka service",
  "description": "Example request to provision a managed Apache Kafka cluster on Aiven",
  "request": {
    "method": "POST",
    "url": "https://api.aiven.io/v1/project/{project}/service",
    "headers": {
      "Authorization": "Bearer {token}",
      "Content-Type": "application/json"
    },
    "body": {
      "service_name": "my-kafka-cluster",
      "service_type": "kafka",
      "cloud_name": "aws-us-east-1",
      "plan": "business-4",
      "kafka": {
        "kafka_version": "3.5"
      }
    }
  },
  "response": {
    "status": 200,
    "body": {
      "service": {
        "service_name": "my-kafka-cluster",
        "service_type": "kafka",
        "state": "REBUILDING",
        "plan": "business-4",
        "cloud_name": "aws-us-east-1"
      }
    }
  }
}