Cisco Crosswork Custom Files API

openapi: 3.2.0
info:
  title: Crosswork Data Gateway Management Custom Software Custom Files API
  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
  x-provenance:
    method: harvested
    authored_by: Cisco Crosswork
    harvested_by: API Evangelist
    harvested_on: '2026-08-19'
    first_party: true
    note: Published by Cisco. Retrieved unmodified except for this x-provenance block.
    provider_published: true
  x-evidence:
  - type: source
    url: https://github.com/CiscoDevNet/crosswork-openapi-spec/blob/master/CDG/2.0APIs/cdg_custom_files_api.swagger.json
  - type: raw
    url: https://raw.githubusercontent.com/CiscoDevNet/crosswork-openapi-spec/master/CDG/2.0APIs/cdg_custom_files_api.swagger.json
servers:
- url: /crosswork/dg-manager
security:
- bearerAuth: []
tags:
- name: Custom Files
paths:
  /v1/custom-files/upload/:
    post:
      summary: Post a custom software file
      description: The custom software file's fileType can be DEVICE_PACKAGE or MIB_PACKAGE. The collectorType can be CLI or SNMP.
      operationId: PostCustomSoftwareFile
      responses:
        '200':
          description: OK. The request was successful. The result is contained in the response body.
          headers: {}
        '400':
          description: Bad Request. The request is malformed in some way and the server cannot process it.
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                fileName:
                  type: string
                  description: '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.'
                fileType:
                  type: string
                  description: The DEVICE_PACKAGE fileType applies to an SNMP or CLI collectorType. The MIB_PACKAGE fileType applies to the SNMP collectorType only.
                collectorType:
                  type: string
                  description: The collectorType can be SNMP or CLI.
                notes:
                  type: string
                  description: A text string describing the custom software package.
                file:
                  type: string
                  format: binary
                  description: The content of the uploaded file.
              required:
              - fileName
              - fileType
              - collectorType
              - file
      tags:
      - Custom Files
    put:
      description: Helps in updating the custom-mib-packages.tar.xz MIB package. Update is supported for custom-mib-packages.tar.xz only.
      summary: Update the custom-mib-packages.tar.xz package.
      operationId: PutUploadMIBPackage
      deprecated: false
      responses:
        '200':
          description: OK. The request was successful. The result is contained in the response body.
          headers: {}
        '400':
          description: Bad Request. The request is malformed in some way and the server cannot process it.
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                fileName:
                  type: string
                  description: For the MIB_PACKAGE fileType only, the filename must be custom-mib-packages.tar.xz.
                fileType:
                  type: string
                  description: The fileType must be MIB_PACKAGE only. Update is supported for custom-mib-packages.tar.xz only.
                collectorType:
                  type: string
                  description: The collectorType must be SNMP. This is the only collector type supported for the PUT operation.
                notes:
                  type: string
                  description: A text string describing the custom software package.
                file:
                  type: string
                  format: binary
                  description: The content of the uploaded file.
              required:
              - fileName
              - fileType
              - collectorType
      tags:
      - Custom Files
  /v1/custom-files/delete:
    delete:
      description: Deletes one or more custom software packages.
      summary: Deletes one or more custom software packages.
      operationId: deleteCustomSoftwarePackage
      deprecated: false
      responses:
        '200':
          description: 'OK. The request was successful. The result is contained in the response body. For example: The custom files specified were deleted.'
        '400':
          description: Bad request - validation errors. Note that deletion stops immediately when a specified file is not found.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/deleteFileContent'
        description: Info that identifies the custom software package files that need to be deleted.
        required: true
      tags:
      - Custom Files
  /v1/custom-files/query:
    post:
      description: Displays all the uploaded custom software files based on a specified range.
      summary: Displays all the uploaded custom software files based on a specified range.
      operationId: GetUploadedCustomSoftware
      deprecated: false
      responses:
        '200':
          description: OK. The request was successful. The result is contained in the response body.
          headers: {}
      requestBody:
        content:
          application/json; charset=UTF-8:
            schema:
              $ref: '#/components/schemas/GETFilesRequest'
        description: The files to be displayed.
        required: true
      tags:
      - Custom Files
  /v1/custom-files/download/{download-file}:
    post:
      description: Downloads the custom MIB packages file 'custom-mib-packages.tar.xz' to the local host.
      summary: Download custom MIB packages file
      operationId: DownloadCustom-mib-packages
      deprecated: false
      parameters:
      - name: download-file
        in: path
        required: true
        description: The custom-mib-packages.tar.xz file
        schema:
          type: string
      responses:
        '200':
          description: OK. The request was successful. The result is contained in the response body.
          content:
            multipart/form-data:
              schema:
                type: string
                format: binary
        '404':
          description: Not Found. The client made a request for a resource that does not exist.
      tags:
      - Custom Files
components:
  schemas:
    DeletePayload:
      title: DeletePayload
      type: object
      properties:
        fileName:
          type: string
        collectorType:
          type: string
        fileType:
          type: string
      required:
      - fileName
      - collectorType
      - fileType
    GETFilesRequest:
      title: GETFilesRequest
      example:
        startRow: 0
        endRow: 10
      type: object
      properties:
        startRow:
          type: integer
          format: int32
          description: Specify the starting row of the custom software files list.
        endRow:
          type: integer
          format: int32
          description: Specify the end row of the custom software files list.
      required:
      - startRow
      - endRow
    deleteFileContent:
      title: deleteFileContent
      example:
        data:
        - fileName: Test.xar
          collectorType: CLI
          fileType: DEVICE_PACKAGE
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/DeletePayload'
      required:
      - data
  securitySchemes:
    bearerAuth:
      type: apiKey
      name: Authorization
      in: header