{"type":"api","title":"Get data destinations","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/b95772dc6c621d9842faced8610ee58b0cb9cb02/ed506c95-6866-3a66-a6b3-5338f7cb6c21","info":{"title":"Crosswork Data Gateway Destination API","description":"This document details Crosswork Data Gateway APIs you can use to create, update and delete CDG data destinations","version":"7.1.0","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"}},"security":[{"bearerAuth":[]}],"tags":[{"name":"Destination operations","description":"Get/Set Destinations in CDG"}],"x-parser-conf":{"overview":{"markdownPath":"reference/CDG/cdg_destination_dg_api_overview.md"}},"swagger":"2.0","basePath":"/crosswork/dg-manager/v1","schemes":["https"],"securityDefinitions":{"bearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"Bearer Auth Token"}}},"spec":{"description":"Get all data destinations in the system.","summary":"Get data destinations","operationId":"GetDestinations","deprecated":false,"produces":["application/json"],"consumes":["application/json"],"parameters":[{"name":"Content-Type","in":"header","required":true,"type":"string","description":"application/json"},{"name":"Body","in":"body","required":true,"description":"Request payload for get destinations","schema":{"title":"GetDestinationsRequest","example":{"limit":100,"filter":{}},"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"filter":{"type":"object"}},"required":["limit","filter"],"$$ref":"#/definitions/GetDestinationsRequest"}}],"responses":{"200":{"description":"OK","schema":{"title":"GetDestinationsResponse","example":{"data":[{"uuid":"c2a8fba8-8363-3d22-b0c2-a9e449693fae","name":"CW_KAFKA_DESTINATION","connectivity_info":[{"type":"ROBOT_MSVC_TRANS_KAFKA","ipaddrs":[{"inet_af":"ROBOT_INET_ADDR_TYPE_v4","inet_addr":"10.14.0.131","mask":"24"}],"port":30993},{"type":"ROBOT_MSVC_TRANS_KAFKA","ipaddrs":[{"inet_af":"ROBOT_INET_ADDR_TYPE_v4","inet_addr":"10.14.0.131","mask":"24"}],"port":30994},{"type":"ROBOT_MSVC_TRANS_KAFKA","ipaddrs":[{"inet_af":"ROBOT_INET_ADDR_TYPE_v4","inet_addr":"10.14.0.131","mask":"24"}],"port":30995}],"family":"ROBOT_PROVIDER_DESTINATION","properties":{"AUTH_TYPE":"mutual","BATCH_SIZE_CONFIG":"6400000","COMPRESSION_TYPE_CONFIG":"snappy","DESTINATION_TYPE":"destination_type_kafka","ENCODING":"gpbkv","IS_SECURITY_ENABLED":"true","IS_SYSTEM_DEFINED":"true","LINGER_MS_CONFIG":"5000","MAX_REQUEST_SIZE_CONFIG":"100000000","BUFFER_MEMORY_CONFIG":"52428800","REQUEST_TIMEOUT_CONFIG":"30"}},{"uuid":"305a4d4e-47af-4baf-b72b-cf112ead1f2a","name":"test-dest-fqdn","connectivity_info":[{"type":"ROBOT_MSVC_TRANS_KAFKA","port":30999,"fqdn":{"host_name":"test","domain_name":"cisco.com"}}],"family":"ROBOT_PROVIDER_DESTINATION","properties":{"BATCH_SIZE_CONFIG":"1048576","BUFFER_MEMORY_CONFIG":"52428800","COMPRESSION_TYPE_CONFIG":"snappy","DESTINATION_TYPE":"destination_type_kafka","ENCODING":"gpbkv","IS_SECURITY_ENABLED":"false","LINGER_MS_CONFIG":"2000","MAX_REQUEST_SIZE_CONFIG":"100000000","REQUEST_TIMEOUT_CONFIG":"30"}}],"total_count":2},"type":"object","properties":{"data":{"type":"array","items":{"title":"GetDestinationsData","example":{"uuid":"c2a8fba8-8363-3d22-b0c2-a9e449693fae","name":"CW_KAFKA_DESTINATION","connectivity_info":[{"type":"ROBOT_MSVC_TRANS_KAFKA","ipaddrs":[{"inet_af":"ROBOT_INET_ADDR_TYPE_v4","inet_addr":"10.14.0.131","mask":"24"}],"port":30993},{"type":"ROBOT_MSVC_TRANS_KAFKA","ipaddrs":[{"inet_af":"ROBOT_INET_ADDR_TYPE_v4","inet_addr":"10.14.0.131","mask":"24"}],"port":30994},{"type":"ROBOT_MSVC_TRANS_KAFKA","ipaddrs":[{"inet_af":"ROBOT_INET_ADDR_TYPE_v4","inet_addr":"10.14.0.131","mask":"24"}],"port":30995}],"family":"ROBOT_PROVIDER_DESTINATION","properties":{"BATCH_SIZE_CONFIG":"6400000","COMPRESSION_TYPE_CONFIG":"snappy","DESTINATION_TYPE":"destination_type_kafka","ENCODING":"gpbkv","IS_SECURITY_ENABLED":"true","IS_SYSTEM_DEFINED":"true","LINGER_MS_CONFIG":"5000","MAX_REQUEST_SIZE_CONFIG":"100000000","BUFFER_MEMORY_CONFIG":"52428800","REQUEST_TIMEOUT_CONFIG":"30"}},"type":"object","properties":{"uuid":{"type":"string"},"name":{"type":"string"},"connectivity_info":{"type":"array","items":{"title":"ConnectivityInfo","example":{"type":"ROBOT_MSVC_TRANS_KAFKA","ipaddrs":[{"inet_af":"ROBOT_INET_ADDR_TYPE_v4","inet_addr":"10.14.0.131","mask":"24"}],"port":30993},"type":"object","properties":{"type":{"type":"string"},"ipaddrs":{"type":"array","items":{"title":"Ipaddr","example":{"inet_af":"ROBOT_INET_ADDR_TYPE_v4","inet_addr":"10.14.0.131","mask":"24"},"type":"object","properties":{"inet_af":{"type":"string"},"inet_addr":{"type":"string"},"mask":{"type":"string"}},"required":["inet_af","inet_addr","mask"],"$$ref":"#/definitions/Ipaddr"}},"port":{"type":"integer","format":"int32"}},"required":["type","ipaddrs","port"],"$$ref":"#/definitions/ConnectivityInfo"}},"family":{"type":"string"},"properties":{"title":"KafkaProperties","example":{"AUTH_TYPE":"mutual","BATCH_SIZE_CONFIG":"6400000","COMPRESSION_TYPE_CONFIG":"snappy","DESTINATION_TYPE":"destination_type_kafka","ENCODING":"gpbkv","IS_SECURITY_ENABLED":"true","IS_SYSTEM_DEFINED":"true","LINGER_MS_CONFIG":"5000","MAX_REQUEST_SIZE_CONFIG":"100000000","BUFFER_MEMORY_CONFIG":"52428800","REQUEST_TIMEOUT_CONFIG":"30"},"type":"object","properties":{"AUTH_TYPE":{"type":"string","enum":["mutual","server"]},"BATCH_SIZE_CONFIG":{"type":"string"},"COMPRESSION_TYPE_CONFIG":{"type":"string"},"DESTINATION_TYPE":{"type":"string"},"ENCODING":{"type":"string"},"IS_SECURITY_ENABLED":{"type":"string"},"IS_SYSTEM_DEFINED":{"type":"string"},"LINGER_MS_CONFIG":{"type":"string"},"MAX_REQUEST_SIZE_CONFIG":{"type":"string"},"REQUEST_TIMEOUT_CONFIG":{"type":"string"}},"required":["BATCH_SIZE_CONFIG","COMPRESSION_TYPE_CONFIG","DESTINATION_TYPE","ENCODING","IS_SECURITY_ENABLED","IS_SYSTEM_DEFINED","LINGER_MS_CONFIG","MAX_REQUEST_SIZE_CONFIG","BUFFER_MEMORY_CONFIG","REQUEST_TIMEOUT_CONFIG"],"$$ref":"#/definitions/KafkaProperties"}},"required":["uuid","name","connectivity_info","family","properties"],"$$ref":"#/definitions/GetDestinationsData"}},"total_count":{"type":"integer","format":"int32"}},"required":["data","total_count"],"$$ref":"#/definitions/GetDestinationsResponse"},"headers":{}},"500":{"description":"Internal Server Error"}},"security":[],"__originalOperationId":"GetDestinations","method":"post","path":"/destinations/query"}}