{"type":"api","title":"Get secure destinations","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 secure destinations","operationId":"getSecureDestinations","requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"This is a object to fetch secure destination","properties":{"limit":{"type":"integer","format":"int32","description":"limit"},"filter":{"type":"object","description":"filter","properties":{},"$$ref":"#/components/schemas/Filter"}},"$$ref":"#/components/schemas/DestinationInputDTO"},"examples":{"example":{"summary":"Sample request","value":{"limit":100,"filter":{}},"$$ref":"#/components/examples/PostDestinationInputDTO"}}}},"required":true},"responses":{"200":{"description":"Success with response message-body","content":{"application/json":{"schema":{"type":"object","description":"This is a record of secure destination","properties":{"data":{"type":"array","description":"Collection of secure destination","items":{"type":"object","description":"This is a record of data in secure destination","properties":{"uuid":{"type":"string","description":"uuid"},"name":{"type":"string","description":"name"},"connectivityInfo":{"type":"array","description":"connectivityInfo","items":{"type":"object","description":"connectivityInfo","properties":{"type":{"type":"string","description":"type"},"ipaddrs":{"type":"array","description":"ipaddrs","items":{"type":"object","description":"ipaddr","properties":{"inetAf":{"type":"string","description":"inetAf"},"inetAddr":{"type":"string","description":"inetAddr"},"mask":{"type":"string","description":"mask"}},"$$ref":"#/components/schemas/Ipaddr"}},"port":{"type":"integer","format":"int32","description":"port"}},"$$ref":"#/components/schemas/ConnectivityInfo"}},"family":{"type":"string","description":"family"},"propertie":{"type":"object","description":"properties","properties":{"batchSizeConfig":{"type":"string","description":"batchSizeConfig"},"bufferMemoryConfig":{"type":"string","description":"bufferMemoryConfig"},"compressionTypeConfig":{"type":"string","description":"compressionTypeConfig"},"destinationType":{"type":"string","description":"destinationType"},"encoding":{"type":"string","description":"encoding"},"isSecurityEnabled":{"type":"string","description":"isSecurityEnabled"},"isSystemDefined":{"type":"string","description":"isSystemDefined"},"lingerMsConfig":{"type":"string","description":"lingerMsConfig"},"maxRequestSizeConfig":{"type":"string","description":"maxRequestSizeConfig"},"requestTimeoutConfig":{"type":"string","description":"requestTimeoutConfig"},"serviceName":{"type":"string","description":"serviceName"},"type":{"type":"string","description":"type"}},"$$ref":"#/components/schemas/KafkaProperties"}},"$$ref":"#/components/schemas/Data"}},"totalCount":{"type":"integer","format":"int32","description":"It represents total number of records"}},"$$ref":"#/components/schemas/KafkaDestinationRootModel"},"examples":{"example":{"summary":"Sample request","value":{"data":[{"uuid":"11613e13-dfc0-3fd8-8970-6fb4b50561e8","name":"KafkaDestinationSec","connectivity_info":[{"type":"ROBOT_MSVC_TRANS_KAFKA","ipaddrs":[{"inet_af":"ROBOT_INET_ADDR_TYPE_v4","inet_addr":"10.78.102.218"}],"port":9093}],"family":"ROBOT_PROVIDER_DESTINATION","properties":{"BATCH_SIZE_CONFIG":"1048576","BUFFER_MEMORY_CONFIG":"104857600","COMPRESSION_TYPE_CONFIG":"gzip","DESTINATION_TYPE":"destination_type_kafka","ENCODING":"json","IS_SECURITY_ENABLED":"true","LINGER_MS_CONFIG":"2000","MAX_REQUEST_SIZE_CONFIG":"1048576","REQUEST_TIMEOUT_CONFIG":"30"}}],"total_count":1},"$$ref":"#/components/examples/GetKafkaDestinationRootModel"}}}}},"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":"post","path":"/externalkafka/securedestination"}}