{"type":"api","title":"Get connection","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/90eed0f5-89f5-3b38-91bd-a82e5776883c","info":{"title":"External Kafka Subscription APIs","description":"External kafka subscription APIs exposed by Notification service.","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"http://www.cisco.com/public/sw-license-agreement.html"},"version":"1.0.0"},"x-parser-conf":{"overview":{"markdownPath":"reference/EMF/Notification/extrnl-kafka-api-overview.md"}},"openapi":"3.1.0","servers":[{"url":"https://{server_ip}:30603/crosswork/notification/v1","description":"Generated server url"}]},"spec":{"tags":["External Kafka Subscription"],"summary":"Get connection","operationId":"getAllKafkaConnectionProperties","responses":{"200":{"description":"Success with response message-body","content":{"application/json":{"schema":{"type":"object","description":"This is a wrapper of ExtnalKafkaPropertyDTO","properties":{"kafkaProperties":{"uniqueItems":true,"type":"array","description":"Collection of ExtnalKafkaPropertyDTO","items":{"type":"object","description":"This is a record of external kafka property","properties":{"batchSize":{"type":"integer","format":"int64","description":"Maximum number of bytes that will be included in one batch","minimum":1048576,"maximum":52428800},"bufferMemory":{"type":"integer","format":"int64","description":"This sets the amount of memory(in bytes) the producer will use to buffer messages waiting to be sent to broker","minimum":104857600,"maximum":209715200},"compressionType":{"type":"string","description":"The messages will be compressed before sending them to the broker, possible values [snappy,gzip,lz4,zsdt,none]"},"destinationName":{"type":"string","description":"Destination name to be created"},"enableSecureCommunication":{"type":"boolean","description":"To enable secure communication [true or false]"},"kafkaServerIPAddress":{"type":"string","description":"Ip-address of kafka-server"},"kafkaServerIPAddressFamily":{"type":"string","description":"Ip-address family, possible values [IPv4, IPv6]"},"kafkaServerPort":{"type":"integer","format":"int32","description":"Port of kafka-server"},"linger":{"type":"integer","format":"int32","description":"The number of milliseconds a producer is willing to wait before sending a batch out","minimum":2000,"maximum":5000},"maxMessageSize":{"type":"integer","format":"int64","description":"Limits the size of messages(in bytes) that it’s allowed to send","minimum":1048576,"maximum":10485760},"requestTimeout":{"type":"integer","format":"int32","description":"The configuration controls the maximum amount of time(in seconds) the client will wait for the response of a request","minimum":30,"maximum":60}},"$$ref":"#/components/schemas/ExtnalKafkaPropertyDTO"}}},"$$ref":"#/components/schemas/ExtnalKafkaPropertiesListDTO"},"examples":{"example":{"summary":"Sample response","value":{"kafkaProperties":[{"batchSize":1048576,"bufferMemory":104857600,"compressionType":"gzip","destinationName":"kafkadest","enableSecureCommunication":false,"kafkaServerIPAddress":"10.78.102.218","kafkaServerIPAddressFamily":"IPV4","kafkaServerPort":9092,"linger":2000,"maxMessageSize":1048576,"requestTimeout":30}]},"$$ref":"#/components/examples/GetKafkaDestination"}}}}},"400":{"description":"Bad Request - Invalid request"},"401":{"description":"Unauthorized. The request has not been applied because it lacks valid authentication credentials for the target resource."},"403":{"description":"Forbidden. The server recognizes the authentication credentials, but the client is not authorized to perform this request."},"500":{"description":"Internal Server Error - operation-failed"}},"method":"get","path":"/externalkafka/destination"}}