MDOQ CLI – MDOQ

All documentation on installing, configuring and using the MDOQ CLI
MDOQ CLI allows you to interact with MDOQ via the CLI on your machine, you can upload/download backups and snapshots as well as much more.

Installation and setup

Download the latest version, place in a location defined in your $PATH and make executable.

wget https://cli.mdoq.dev/latest/mdoq -O /usr/local/bin/mdoq && chmod a+x /usr/local/bin/mdoq

Add your API token

mdoq configure:set api_token "API_TOKEN"

(see here for info on how to obtain your API token)

Usage

Just running the mdoq command with no arguments will give you a list of possible commands as well descriptions of the arguments available to each command.

mdoq action-log

Commands to interact with the action logs visible within MDOQ

mdoq action-log:create

Description:
  Create an action log

Usage:
  action-log:create [options]

Options:
  -i, --instance-id=INSTANCE-ID
      --summary=SUMMARY
      --parent-id[=PARENT-ID]
      --detail[=DETAIL]          Additional information for the log [default: ""]
      --state[=STATE]            The state of the log [default: "running"]

mdoq action-log:update

Description:
  Update an action log

Usage:
  action-log:update [options]

Options:
  -i, --id=ID                      The ID of the log to update
      --summary[=SUMMARY]
      --detail[=DETAIL]            Additional information for the log
      --state[=STATE]              The state of the log
      --update-mode[=UPDATE-MODE]  How to update the log detail. (overwrite or append) [default: "append"]

mdoq backups

Commands to interact with the backups MDOQ has for your instances.

Code and Database backup commands can only be ran against Production or Live Connector instances, was development instances have no store for these types of backups.

Backup Types

code-backup
db-backup
full-db-backup
elasticsearch-snapshot

mdoq backups:download

Description:
  Download a backup

Usage:
  backups:download [options]

Options:
      --name=NAME
  -i, --instance-id=INSTANCE-ID
  -t, --backup-type=BACKUP-TYPE
  -o, --output-file[=OUTPUT-FILE]

mdoq backups:list

Description:
  List backups for an instance

Usage:
  backups:list [options]

Options:
  -i, --instance-id=INSTANCE-ID
  -t, --backup-type=BACKUP-TYPE

mdoq backups:push

Description:
  Push a local backup to MDOQ

Usage:
  backups:push [options]

Options:
  -f, --file=FILE
  -i, --instance-id=INSTANCE-ID
  -t, --backup-type=BACKUP-TYPE
      --name[=NAME]

mdoq lock

Commands to interact with MDOQ locks

mdoq lock:unlock

Description:
  Remove a lock

Usage:
  lock:unlock [options]

Options:
      --tag=TAG         The tag of the lock

mdoq webhook-history

Commands to interact with MDOQ webhook histories

mdoq webhook-history:update

Description:
  Remove a lock

Usage:
  lock:unlock [options]

Options:
      --tag=TAG         The tag of the lock