{"type":"api","title":"Post a custom software file","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/f8aef008-b88b-3fd6-b95f-e63951de2eb0","info":{"title":"Crosswork Data Gateway Custom Software API- v1 (Deprecated)","description":"APIs to support Cisco Crosswork Data Gateway Management's custom software functionality.","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"},"security":[{"bearerAuth":[]}],"x-parser-conf":{"overview":{"markdownPath":"reference/CDG/Deprecated/cdg_custom_files_api_v1-overview.md"}},"swagger":"2.0","basePath":"/crosswork/dg-manager","schemes":["https"],"securityDefinitions":{"bearerAuth":{"type":"apiKey","name":"Authorization","in":"header","description":"Bearer Auth Token"}}},"spec":{"summary":"Post a custom software file","deprecated":true,"description":"The custom software file's fileType can be AGGREGATE_SOUTHBOUND_PACKAGE, DEVICE_PACKAGE or MIB_PACKAGE. The collectorType can be COMMON, CLI or SNMP, or COMMON. Guidance is to leverage the COMMON AGGREGATE_SOUTHBOUND_PACKAGE moving forward, as older types will become deprecated.","operationId":"PostCustomSoftwareFile","produces":["application/json"],"consumes":["multipart/form-data"],"parameters":[{"name":"fileName","in":"formData","required":true,"type":"string","description":"AGGREGATE_SOUTHBOUND_PACKAGE fileName expects file with extension (.tar.gz). For the SNMP DEVICE_PACKAGE fileType, the fileName must be an XDE PAL/XDE device package archive with the .xar extension. For example: custom_show_cdp.xar. For the MIB_PACKAGE fileType, the fileName must be custom-mib-packages.tar.xz. For CLI DEVICE_PACKAGE fileType, file name must be custom-cli-device-packages.tar.xz."},{"name":"fileType","in":"formData","required":true,"type":"string","description":"The AGGREGATE_SOUTHBOUND_PACKAGE fileType applies to the COMMON collectorType exclusively. The DEVICE_PACKAGE fileType applies to an SNMP or CLI collectorType. The MIB_PACKAGE fileType applies to the SNMP collectorType only."},{"name":"collectorType","in":"formData","required":true,"type":"string","description":"The collectorType is COMMON for AGGREGATE_SOUTHBOUND_PACKAGE. Otherwise, the collectorType can be SNMP or CLI."},{"name":"notes","in":"formData","required":false,"type":"string","description":"A text string describing the custom software package."},{"name":"file","in":"formData","required":true,"type":"file","format":"binary","description":"The content of the uploaded file."}],"responses":{"200":{"description":"OK. The request was successful.","schema":{"title":"FileUploadResponse","example":{"fileName":"custom-cli-device-packages.tar.xz","modifiedTime":1706862398,"bundleType":"","fileType":"DEVICE_PACKAGE","collectorType":"CLI","notes":"Test","appName":"","downloadUrl":""},"properties":{"fileName":{"type":"string"},"modifiedTime":{"type":"integer"},"bundleType":{"type":"string"},"fileType":{"type":"string"},"collectorType":{"type":"string"},"notes":{"type":"string"},"appName":{"type":"string"},"downloadUrl":{"type":"string"}},"$$ref":"#/definitions/FileUploadResponse"},"headers":{}},"400":{"description":"Bad Request. The request is malformed in some way and the server cannot process it."}},"__originalOperationId":"PostCustomSoftwareFile","security":[{"bearerAuth":[]}],"method":"post","path":"/v1/custom-files/upload/"}}