CloudConvert

Use the CloudConvert integration to convert your files to the desired format.

Utilities · Cloud Convert

Details

IDCloudConvert
ProviderLunaweb GmbH
CategoryUtilities
From Version5.0.0
Docker Imagedemisto/python3:3.12.13.10116658
Supported ModulesAgentix XSIAM

README

Use the CloudConvert integration to convert your files to the required format.
This integration was integrated and tested with version v2 of CloudConvert.

Configure CloudConvert in Cortex

Parameter Description Required
apikey API Key True
insecure Trust any certificate (not secure) False
proxy Use system proxy settings False

Commands

You can execute these commands from the CLI, as part of an automation, or in a playbook.
After you successfully execute a command, a DBot message appears in the War Room with the command details.

cloudconvert-upload

Uploads a file for conversion.

Base Command

cloudconvert-upload

Input

Argument Name Description Required
url The file’s URL. If an entry ID is supplied, do not use this argument. Optional
entry_id The file’s War Room entry ID. If a URL is supplied, do not use this argument. Optional

Context Output

Path Type Description
CloudConvert.Task.id String Unique task ID of the scanned file.
CloudConvert.Task.status String Status of the current task.
CloudConvert.Task.message String Response message from the API.
CloudConvert.Task.operation String The operation that was performed.
CloudConvert.Task.result.files.filename String The name of the uploaded file.
CloudConvert.Task.result.files.size Number The size of the uploaded file.
CloudConvert.Task.result.files.url String The URL of the uploaded file.
CloudConvert.Task.created_at Date Time the task was created.
CloudConvert.Task.started_at Date Start time of the task.
CloudConvert.Task.ended_at Date End time of the task.
CloudConvert.Task.host_name String Name of the host used for the task.
CloudConvert.Task.storage String Storage server used for the task.
CloudConvert.Task.links String API link for the task.

Command Example

cloudconvert-upload entry_id=@123

Human Readable Output

cloudconvert-convert

Converts an uploaded file to the required format.

Base Command

cloudconvert-convert

Input

Argument Name Description Required
task_id ID of the task that uploaded the file. Required
output_format The required output format for the given file. Required

Context Output

Path Type Description
CloudConvert.Task.id String Unique task ID of the scanned file.
CloudConvert.Task.status String Status of the current task.
CloudConvert.Task.message String Response message from the API.
CloudConvert.Task.operation String The task that was performed.
CloudConvert.Task.result.files.filename String The name of the converted file.
CloudConvert.Task.result.files.size Number The size of the converted file.
CloudConvert.Task.result.files.url String The URL of the converted file.
CloudConvert.Task.created_at Date Time the task was created.
CloudConvert.Task.started_at Date Start time of the task.
CloudConvert.Task.ended_at Date End time of the task.
CloudConvert.Task.host_name String Name of the host used for the task.
CloudConvert.Task.storage String Storage server used for the task.
CloudConvert.Task.depends_on_task_ids String The ID of the previous task that was conducted on this file.
CloudConvert.Task.links String API link for the task.

Command Example

cloudconvert-convert task_id=1 output_format=pdf

Human Readable Output

cloudconvert-check-status

Checks the status of an operation. Use the ‘create_war_room_entry’ argument to also create a war room entry of the file when checking on a download operation.

Base Command

cloudconvert-check-status

Input

Argument Name Description Required
task_id ID of the task used to convert the file. Required
create_war_room_entry Whether to create an entry in the War Room if the task is finished. Possible values are: “True” and “False”. Use this argument to be able to check on a download operation in the War Room. Optional

Context Output

Path Type Description
CloudConvert.Task.id String Unique task ID of the scanned file.
CloudConvert.Task.status String Status of the current task.
CloudConvert.Task.message String Response message from the API.
CloudConvert.Task.operation String The task that was performed.
CloudConvert.Task.result.files.filename String The name of the converted file.
CloudConvert.Task.result.files.size Number The size of the converted file.
CloudConvert.Task.result.files.url String The URL of the converted file.
CloudConvert.Task.created_at Date The time the task was created.
CloudConvert.Task.started_at Date Start time of the task.
CloudConvert.Task.ended_at Date End time of the task.
CloudConvert.Task.host_name String Name of the host used for the task.
CloudConvert.Task.storage String Storage server used for the task.
CloudConvert.Task.depends_on_task_ids String The ID of the previous task conducted on this file.
CloudConvert.Task.links String API link for the task.

Command Example

cloudconvert-check-status task_id=1

Human Readable Output

cloudconvert-download

Downloads a converted file as a URL or a War Room entry.

Base Command

cloudconvert-download

Input

Argument Name Description Required
download_as ‘Whether to download the converted file as a URL or as a War Room entry. Possible values are: “url” and “war_room_entry”. Note that if you download the file as a War Room entry, a URL of the file will also be generated.’ Required
task_id ID of the task that converted the file. Required

Context Output

Path Type Description
CloudConvert.Task.id String Unique task ID of the scanned file.
CloudConvert.Task.status String Status of the current task.
CloudConvert.Task.message String Response message from the API.
CloudConvert.Task.operation String The operation that was performed.
CloudConvert.Task.result.files.filename String The file name of the downloaded file.
CloudConvert.Task.result.files.size Number The size of the downloaded file.
CloudConvert.Task.result.files.url String The URL of the downloaded file.
CloudConvert.Task.created_at Date Time the task was created.
CloudConvert.Task.started_at Date Start time of the task.
CloudConvert.Task.ended_at Date End time of the task.
CloudConvert.Task.host_name String Name of the host used for the task.
CloudConvert.Task.storage String Storage server used for the task.
CloudConvert.Task.depends_on_task_ids String The ID of the previous task conducted on this file.
CloudConvert.Task.links String API link for the task.

Command Example

cloudconvert-download task_id=1 download_as=url

Human Readable Output

Configuration parameters

  • apikey — API Key
  • apikey_creds —
  • insecure — Trust any certificate (not secure)
  • proxy — Use system proxy settings

Commands (4)

  • cloudconvert-check-status

    Checks the status of an operation. Use the create_war_room_entry argument to also create a war room entry of the file when checking on a download operation.

  • cloudconvert-convert

    Converts an uploaded file to the required format.

  • cloudconvert-download

    Downloads a converted file to a URL or a War Room entry.

  • cloudconvert-upload

    Uploads a file to convert.

Source

CloudConvert.py CloudConvert_test.py CloudConvert.yml CloudConvert_description.md
Download History Raw 
category: Utilities
provider: Lunaweb GmbH
commonfields:
  id: CloudConvert
  version: -1
configuration:
- display: API Key
  name: apikey
  required: false
  type: 4
  hidden: true
- name: apikey_creds
  required: false
  type: 9
  displaypassword: API Key
  hiddenusername: true
- display: Trust any certificate (not secure)
  name: insecure
  type: 8
  required: false
- defaultvalue: 'false'
  display: Use system proxy settings
  name: proxy
  type: 8
  required: false
description: Use the CloudConvert integration to convert your files to the desired format.
display: CloudConvert
name: CloudConvert
script:
  commands:
  - arguments:
    - description: The file's URL. If an entry ID is supplied, do not use this argument.
      name: url
    - description: The file's War Room entry ID. If a URL is supplied, do not use this argument.
      name: entry_id
    description: Uploads a file to convert.
    name: cloudconvert-upload
    outputs:
    - contextPath: CloudConvert.Task.id
      description: Unique task ID of the scanned file.
      type: String
    - contextPath: CloudConvert.Task.status
      description: Status of the current task.
      type: String
    - contextPath: CloudConvert.Task.message
      description: Response message from the API.
      type: String
    - contextPath: CloudConvert.Task.operation
      description: The operation that was performed.
      type: String
    - contextPath: CloudConvert.Task.result.files.filename
      description: The name of the uploaded file.
      type: String
    - contextPath: CloudConvert.Task.result.files.size
      description: The size of the uploaded file.
      type: Number
    - contextPath: CloudConvert.Task.result.files.url
      description: The URL of the uploaded file.
      type: String
    - contextPath: CloudConvert.Task.created_at
      description: Time the task was created.
      type: Date
    - contextPath: CloudConvert.Task.started_at
      description: Start time of the task.
      type: Date
    - contextPath: CloudConvert.Task.ended_at
      description: End time of the task.
      type: Date
    - contextPath: CloudConvert.Task.host_name
      description: Name of the host used for the task.
      type: String
    - contextPath: CloudConvert.Task.storage
      description: Storage server used for the task.
      type: String
    - contextPath: CloudConvert.Task.links
      description: API link for the task.
      type: String
  - arguments:
    - description: ID of the task that uploaded the file.
      name: task_id
      required: true
    - auto: PREDEFINED
      description: 'The required output format for the given file. The supported destination formats are: 3g2, 3gp, 3gpp, 7z, aac, ac3, aif, aifc, aiff, amr, au, avi, azw3, bmp, caf, cavs, cgm, csv, doc, docx, dv, dvr, dwg, dxf, emf, eot, eps, epub, flac, flv, gif, html, icns, ico, jpg, lrf, m2ts, m4a, m4b, m4v, md, mkv, mobi, mod, mov, mp3, mp4, mpeg, mpg, mts, mxf, odd, odp, ods, odt, oeb, oga, ogg, otf, pdb, pdf, png, ppt, pptx, ps, psd, rar, rm, rmvb, rst, rtf, sf2, svg, swf, tar, tar.bz2, tar.gz, tar.lzo, tex, tiff, ts, ttf, txt, vob, voc, wav, weba, webm, webp, wma, wmf, wmv, woff, woff2, wtv, xls, xlsx, xps, zip.'
      name: output_format
      predefined:
      - 3g2
      - 3gp
      - 3gpp
      - 7z
      - aac
      - ac3
      - aif
      - aifc
      - aiff
      - amr
      - au
      - avi
      - azw3
      - bmp
      - caf
      - cavs
      - cgm
      - csv
      - doc
      - docx
      - dv
      - dvr
      - dwg
      - dxf
      - emf
      - eot
      - eps
      - epub
      - flac
      - flv
      - gif
      - html
      - icns
      - ico
      - jpg
      - lrf
      - m2ts
      - m4a
      - m4b
      - m4v
      - md
      - mkv
      - mobi
      - mod
      - mov
      - mp3
      - mp4
      - mpeg
      - mpg
      - mts
      - mxf
      - odd
      - odp
      - ods
      - odt
      - oeb
      - oga
      - ogg
      - otf
      - pdb
      - pdf
      - png
      - ppt
      - pptx
      - ps
      - psd
      - rar
      - rm
      - rmvb
      - rst
      - rtf
      - sf2
      - svg
      - swf
      - tar
      - tar.bz2
      - tar.gz
      - tar.lzo
      - tex
      - tiff
      - ts
      - ttf
      - txt
      - vob
      - voc
      - wav
      - weba
      - webm
      - webp
      - wma
      - wmf
      - wmv
      - woff
      - woff2
      - wtv
      - xls
      - xlsx
      - xps
      - zip
      required: true
    description: Converts an uploaded file to the required format.
    name: cloudconvert-convert
    outputs:
    - contextPath: CloudConvert.Task.id
      description: Unique task ID of the scanned file.
      type: String
    - contextPath: CloudConvert.Task.status
      description: Status of the current task.
      type: String
    - contextPath: CloudConvert.Task.message
      description: Response message from the API.
      type: String
    - contextPath: CloudConvert.Task.operation
      description: The task that was performed.
      type: String
    - contextPath: CloudConvert.Task.result.files.filename
      description: The name of the converted file.
      type: String
    - contextPath: CloudConvert.Task.result.files.size
      description: The size of the converted file.
      type: Number
    - contextPath: CloudConvert.Task.result.files.url
      description: The URL of the converted file.
      type: String
    - contextPath: CloudConvert.Task.created_at
      description: Time the task was created.
      type: Date
    - contextPath: CloudConvert.Task.started_at
      description: Start time of the task.
      type: Date
    - contextPath: CloudConvert.Task.ended_at
      description: End time of the task.
      type: Date
    - contextPath: CloudConvert.Task.host_name
      description: Name of the host used for the task.
      type: String
    - contextPath: CloudConvert.Task.storage
      description: Storage server used for the task.
      type: String
    - contextPath: CloudConvert.Task.depends_on_task_ids
      description: The ID of the previous task that was conducted on this file.
      type: String
    - contextPath: CloudConvert.Task.links
      description: API link for the task.
      type: String
  - arguments:
    - description: ID of the task used to convert the file.
      name: task_id
      required: true
    - description: 'Whether to create an entry in the War Room if the task is finished. Possible values are: "True" and "False". Use this argument to be able to check on an download operation in the War Room.'
      name: create_war_room_entry
      predefined:
      - 'True'
      - 'False'
    description: Checks the status of an operation. Use the create_war_room_entry argument to also create a war room entry of the file when checking on a download operation.
    name: cloudconvert-check-status
    outputs:
    - contextPath: CloudConvert.Task.id
      description: Unique task ID of the scanned file.
      type: String
    - contextPath: CloudConvert.Task.status
      description: Status of the current task.
      type: String
    - contextPath: CloudConvert.Task.message
      description: Response message from the API.
      type: String
    - contextPath: CloudConvert.Task.operation
      description: The task that was performed.
      type: String
    - contextPath: CloudConvert.Task.result.files.filename
      description: The name of the converted file.
      type: String
    - contextPath: CloudConvert.Task.result.files.size
      description: The size of the converted file.
      type: Number
    - contextPath: CloudConvert.Task.result.files.url
      description: The URL of the converted file.
      type: String
    - contextPath: CloudConvert.Task.created_at
      description: The time the task was created.
      type: Date
    - contextPath: CloudConvert.Task.started_at
      description: Start time of the task.
      type: Date
    - contextPath: CloudConvert.Task.ended_at
      description: End time of the task.
      type: Date
    - contextPath: CloudConvert.Task.host_name
      description: Name of the host used for the task.
      type: String
    - contextPath: CloudConvert.Task.storage
      description: Storage server used for the task.
      type: String
    - contextPath: CloudConvert.Task.depends_on_task_ids
      description: The ID of the previous task conducted on this file.
      type: String
    - contextPath: CloudConvert.Task.links
      description: API link for the task.
      type: String
  - arguments:
    - auto: PREDEFINED
      description: 'Whether to download the converted file to a URL or as a War Room entry. Possible values are: "url" and "war_room_entry". Note that if you download the file as a War Room entry, a URL of the file will also be generated.'
      name: download_as
      predefined:
      - url
      - war_room_entry
      required: true
    - description: ID of the task that converted the file.
      name: task_id
      required: true
    description: Downloads a converted file to a URL or a War Room entry.
    name: cloudconvert-download
    outputs:
    - contextPath: CloudConvert.Task.id
      description: Unique task ID of the scanned file.
      type: String
    - contextPath: CloudConvert.Task.status
      description: Status of the current task.
      type: String
    - contextPath: CloudConvert.Task.message
      description: Response message from the API.
      type: String
    - contextPath: CloudConvert.Task.operation
      description: The operation that was performed.
      type: String
    - contextPath: CloudConvert.Task.result.files.filename
      description: The file name of the downloaded file.
      type: String
    - contextPath: CloudConvert.Task.result.files.size
      description: The size of the downloaded file.
      type: Number
    - contextPath: CloudConvert.Task.result.files.url
      description: The URL of the downloaded file.
      type: String
    - contextPath: CloudConvert.Task.created_at
      description: Time the task was created.
      type: Date
    - contextPath: CloudConvert.Task.started_at
      description: Start time of the task.
      type: Date
    - contextPath: CloudConvert.Task.ended_at
      description: End time of the task.
      type: Date
    - contextPath: CloudConvert.Task.host_name
      description: Name of the host used for the task.
      type: String
    - contextPath: CloudConvert.Task.storage
      description: Storage server used for the task.
      type: String
    - contextPath: CloudConvert.Task.depends_on_task_ids
      description: The ID of the previous task conducted on this file.
      type: String
    - contextPath: CloudConvert.Task.links
      description: API link for the task.
      type: String
  dockerimage: demisto/python3:3.12.13.10116658
  runonce: false
  script: '-'
  subtype: python3
  type: python
tests:
- CloudConvert-test
fromversion: 5.0.0