Create data destination - Crosswork Network Controller 7.1 APIs

{"type":"api","title":"Create data destination","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":"Create one or more data destinations by providing the details in the request payload. Collectors may have certain custom properties that would be applied for that specific collector only.","summary":"Create data destination","operationId":"CreateDestination","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 creating Kafaka Destination","schema":{"title":"CreateKafkaDestinationRequest","example":[{"providers":[{"name":"kafka-1","connectivity_info":[{"type":"ROBOT_MSVC_TRANS_KAFKA","ipaddrs":[{"inet_af":"ROBOT_INET_ADDR_TYPE_v4","inet_addr":"10.14.0.150","mask":"20"}],"port":9192}],"family":"ROBOT_PROVIDER_DESTINATION","properties":{"BATCH_SIZE_CONFIG":"6400000","COMPRESSION_TYPE_CONFIG":"snappy","DESTINATION_TYPE":"destination_type_kafka","ENCODING":"gpbkv","IS_SECURITY_ENABLED":"false","IS_SYSTEM_DEFINED":"false","LINGER_MS_CONFIG":"3000","MAX_REQUEST_SIZE_CONFIG":"1000000","CLI.BATCH_SIZE_CONFIG":"1000000","CLI.BUFFER_MEMORY_CONFIG":"314572800","SNMP.LINGER_MS_CONFIG":"2000","BUFFER_MEMORY_CONFIG":"52428800","REQUEST_TIMEOUT_CONFIG":"30"}}]},{"providers":[{"name":"grpc-dest-1","connectivity_info":[{"ipaddrs":[{"inet_af":"ROBOT_INET_ADDR_TYPE_v4","inet_addr":"10.14.0.150","mask":"20"}],"type":"ROBOT_MSVC_TRANS_GRPC","port":50052}],"family":"ROBOT_PROVIDER_DESTINATION","properties":{"ENCODING":"gpbkv","COMPRESSION_TYPE_CONFIG":"gzip","IS_SECURITY_ENABLED":"false","REQUEST_TIMEOUT_CONFIG":"30","DESTINATION_TYPE":"destination_type_grpc","GRPC_DISPATCH_TYPE":"unary","BUFFER_MEMORY_CONFIG":"52428800","ALLOW_DUPE_CONN":"false"}}]}],"type":"object","properties":{"providers":{"type":"array","items":{"title":"KafkaDestination","example":{"name":"kafka-1","connectivity_info":[{"type":"ROBOT_MSVC_TRANS_KAFKA","ipaddrs":[{"inet_af":"ROBOT_INET_ADDR_TYPE_v4","inet_addr":"10.14.0.150","mask":"20"}],"port":9192}],"family":"ROBOT_PROVIDER_DESTINATION","properties":{"BATCH_SIZE_CONFIG":"6400000","COMPRESSION_TYPE_CONFIG":"snappy","DESTINATION_TYPE":"destination_type_kafka","ENCODING":"gpbkv","IS_SECURITY_ENABLED":"false","IS_SYSTEM_DEFINED":"false","LINGER_MS_CONFIG":"3000","MAX_REQUEST_SIZE_CONFIG":"1000000","BUFFER_MEMORY_CONFIG":"52428800","REQUEST_TIMEOUT_CONFIG":"30"}},"type":"object","properties":{"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":["name","connectivity_info","family","properties"],"$$ref":"#/definitions/KafkaDestination"}}},"required":["providers"],"$$ref":"#/definitions/CreateKafkaDestinationRequest"}}],"responses":{"200":{"description":"OK","schema":{"title":"CreateKafkaDestinationResponse","example":{"job_id":"b0663c54-68bb-4c3b-af39-f41d38a151aa","state":"JOB_COMPLETED","type":"Insert Destination","completion_time":"1627153196","creation_time":"1627153190","created_by":"admin"},"type":"object","properties":{"job_id":{"type":"string"},"state":{"type":"string"},"type":{"type":"string"},"completion_time":{"type":"string"},"creation_time":{"type":"string"},"created_by":{"type":"string"}},"required":["job_id","state","type","completion_time","creation_time","created_by"],"$$ref":"#/definitions/CreateKafkaDestinationResponse"},"headers":{}},"500":{"description":"Internal Server Error"}},"security":[],"__originalOperationId":"CreateDestination","method":"post","path":"/destinations"}}