sjwc-dh-api

DreamHost API Command Line Interface

Usage

Usage

$ npm install -g sjwc-dh-api
$ dh-api COMMAND
running command...
$ dh-api (-v|--version|version)
sjwc-dh-api/0.0.2 linux-x64 node-v12.16.3
$ dh-api --help [COMMAND]
USAGE
$ dh-api COMMAND
...

Commands

dh-api account
dh-api account:domain
dh-api account:keys
dh-api account:status
dh-api account:user
dh-api config
dh-api dns
dh-api dns:add
dh-api dns:list
dh-api dns:remove
dh-api domain
dh-api domain:available
dh-api domain:domains
dh-api domain:registrations
dh-api hello [STRING]
dh-api help [COMMAND]
dh-api jabber
dh-api jabber:add
dh-api jabber:deactivate
dh-api jabber:domains
dh-api jabber:reactivate
dh-api jabber:remove
dh-api jabber:users
dh-api list
dh-api list:add
dh-api list:lists
dh-api list:post
dh-api list:remove
dh-api list:subscribers
dh-api mail
dh-api mail:add
dh-api mail:list
dh-api mail:remove
dh-api meta
dh-api meta:commands
dh-api meta:keys
dh-api mysql
dh-api mysql:host
dh-api mysql:host:add
dh-api mysql:host:list
dh-api mysql:host:remove
dh-api mysql:user
dh-api mysql:user:add
dh-api mysql:user:list
dh-api mysql:user:remove
dh-api rewards
dh-api rewards:add
dh-api rewards:details
dh-api rewards:disable
dh-api rewards:enable
dh-api rewards:list
dh-api rewards:log
dh-api rewards:remove
dh-api rewards:summary
dh-api services
dh-api services:fivencoder
dh-api services:progress
dh-api user
dh-api user:add
dh-api user:list
dh-api user:remove

`dh-api account`

Account API Overview

USAGE
  $ dh-api account

OPTIONS
  -h, --help  show CLI help

DESCRIPTION
  The Account module provides commands to check usage and
  status of your account.

See code: src/commands/account/index.ts

`dh-api account:domain`

Returns bandwidth usage for all visible domain services

USAGE
  $ dh-api account:domain

OPTIONS
  -a, --account=account  account to use
  -f, --format=format    format to return

DESCRIPTION
  Bandwidth usage is counted from the beginning of the
  current billing cycle (which, itself, can be determined
  by using account:status).

See code: src/commands/account/domain.ts

`dh-api account:keys`

List all SSH public keys on this account.

USAGE
  $ dh-api account:keys

OPTIONS
  -a, --account=account  account to use
  -f, --format=format    format to return

DESCRIPTION
  Returns a list of all public SSH keys associated with
  this account.

  NOTE:  If individual users have their own key(s), you
         will NOT be able to see them.

See code: src/commands/account/keys.ts

`dh-api account:status`

Returns the status of the current account.

USAGE
  $ dh-api account:status

OPTIONS
  -a, --account=account  account to use
  -f, --format=format    format to return

DESCRIPTION
  Returns the current account status (billing).

See code: src/commands/account/status.ts

`dh-api account:user`

Returns disk and bandwidth usage for all visible users.

USAGE
  $ dh-api account:user

OPTIONS
  -a, --account=account  account to use
  -f, --format=format    format to return

DESCRIPTION
  For all visible users, this returns information on disk
  and bandwidth usage.

See code: src/commands/account/user.ts

`dh-api config`

configure the CLI

USAGE
  $ dh-api config

OPTIONS
  -h, --help  show CLI help

See code: src/commands/config.ts

`dh-api dns`

DNS API

USAGE
  $ dh-api dns

OPTIONS
  -h, --help  show CLI help

See code: src/commands/dns/index.ts

`dh-api dns:add`

dns:add

USAGE
  $ dh-api dns:add

OPTIONS
  -a, --account=account  account to use
  -f, --format=format    format to return

See code: src/commands/dns/add.ts

`dh-api dns:list`

dns:list

USAGE
  $ dh-api dns:list

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/dns/list.ts

`dh-api dns:remove`

dns:remove

USAGE
  $ dh-api dns:remove

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/dns/remove.ts

`dh-api domain`

Domain API

USAGE
  $ dh-api domain

OPTIONS
  -h, --help  show CLI help

See code: src/commands/domain/index.ts

`dh-api domain:available`

domain:available

USAGE
  $ dh-api domain:available

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/domain/available.ts

`dh-api domain:domains`

domain:domains

USAGE
  $ dh-api domain:domains

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/domain/domains.ts

`dh-api domain:registrations`

domain:registrations

USAGE
  $ dh-api domain:registrations

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/domain/registrations.ts

`dh-api hello [STRING]`

this line always shows up here

USAGE
  $ dh-api hello [STRING]

ARGUMENTS
  STRING  [default: world] optional string to echo back

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

DESCRIPTION
  This line shows up here.
  testing, one, two three ...

EXAMPLE
  $ dh-api hello
  hello world from ../src/commands/hello.ts

See code: src/commands/hello.ts

`dh-api help [COMMAND]`

display help for dh-api

USAGE
  $ dh-api help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

`dh-api jabber`

Jabber API

USAGE
  $ dh-api jabber

OPTIONS
  -h, --help  show CLI help

See code: src/commands/jabber/index.ts

`dh-api jabber:add`

jabber:add

USAGE
  $ dh-api jabber:add

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/jabber/add.ts

`dh-api jabber:deactivate`

jabber:deactivate

USAGE
  $ dh-api jabber:deactivate

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/jabber/deactivate.ts

`dh-api jabber:domains`

jabber:domains

USAGE
  $ dh-api jabber:domains

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/jabber/domains.ts

`dh-api jabber:reactivate`

jabber:reactivate

USAGE
  $ dh-api jabber:reactivate

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/jabber/reactivate.ts

`dh-api jabber:remove`

jabber:remove

USAGE
  $ dh-api jabber:remove

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/jabber/remove.ts

`dh-api jabber:users`

jabber:user

USAGE
  $ dh-api jabber:users

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/jabber/users.ts

`dh-api list`

Announcement List API

USAGE
  $ dh-api list

OPTIONS
  -h, --help  show CLI help

See code: src/commands/list/index.ts

`dh-api list:add`

list:add

USAGE
  $ dh-api list:add

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/list/add.ts

`dh-api list:lists`

list:lists

USAGE
  $ dh-api list:lists

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/list/lists.ts

`dh-api list:post`

list:post

USAGE
  $ dh-api list:post

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/list/post.ts

`dh-api list:remove`

list:remove

USAGE
  $ dh-api list:remove

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/list/remove.ts

`dh-api list:subscribers`

list:subscribers

USAGE
  $ dh-api list:subscribers

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/list/subscribers.ts

`dh-api mail`

Mail API

USAGE
  $ dh-api mail

OPTIONS
  -h, --help  show CLI help

See code: src/commands/mail/index.ts

`dh-api mail:add`

mail:add

USAGE
  $ dh-api mail:add

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/mail/add.ts

`dh-api mail:list`

mail:list

USAGE
  $ dh-api mail:list

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/mail/list.ts

`dh-api mail:remove`

mail:remove

USAGE
  $ dh-api mail:remove

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/mail/remove.ts

`dh-api meta`

API metacommands

USAGE
  $ dh-api meta

OPTIONS
  -a, --account=account  account to use
  -f, --format=format    format to return

See code: src/commands/meta/index.ts

`dh-api meta:commands`

meta:commands

USAGE
  $ dh-api meta:commands

OPTIONS
  -a, --account=account  account to use
  -f, --format=format    format to return

See code: src/commands/meta/commands.ts

`dh-api meta:keys`

meta:keys

USAGE
  $ dh-api meta:keys

OPTIONS
  -a, --account=account  account to use
  -f, --format=format    format to return

See code: src/commands/meta/keys.ts

`dh-api mysql`

MySQL API

USAGE
  $ dh-api mysql

OPTIONS
  -h, --help  show CLI help

See code: src/commands/mysql/index.ts

`dh-api mysql:host`

mysql:host

USAGE
  $ dh-api mysql:host

OPTIONS
  -h, --help  show CLI help

See code: src/commands/mysql/host/index.ts

`dh-api mysql:host:add`

mysql:host:add

USAGE
  $ dh-api mysql:host:add

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/mysql/host/add.ts

`dh-api mysql:host:list`

mysql:host:list

USAGE
  $ dh-api mysql:host:list

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/mysql/host/list.ts

`dh-api mysql:host:remove`

mysql:host:remove

USAGE
  $ dh-api mysql:host:remove

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/mysql/host/remove.ts

`dh-api mysql:user`

mysql:user:index

USAGE
  $ dh-api mysql:user

OPTIONS
  -h, --help  show CLI help

See code: src/commands/mysql/user/index.ts

`dh-api mysql:user:add`

mysql:user:add

USAGE
  $ dh-api mysql:user:add

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/mysql/user/add.ts

`dh-api mysql:user:list`

mysql:user:list

USAGE
  $ dh-api mysql:user:list

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/mysql/user/list.ts

`dh-api mysql:user:remove`

mysql:user:remove

USAGE
  $ dh-api mysql:user:remove

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/mysql/user/remove.ts

`dh-api rewards`

Rewards API

USAGE
  $ dh-api rewards

OPTIONS
  -h, --help  show CLI help

See code: src/commands/rewards/index.ts

`dh-api rewards:add`

rewards:add

USAGE
  $ dh-api rewards:add

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/rewards/add.ts

`dh-api rewards:details`

rewards:details

USAGE
  $ dh-api rewards:details

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/rewards/details.ts

`dh-api rewards:disable`

rewards:disable

USAGE
  $ dh-api rewards:disable

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/rewards/disable.ts

`dh-api rewards:enable`

rewards:enable

USAGE
  $ dh-api rewards:enable

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/rewards/enable.ts

`dh-api rewards:list`

rewards:list

USAGE
  $ dh-api rewards:list

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/rewards/list.ts

`dh-api rewards:log`

rewards:log

USAGE
  $ dh-api rewards:log

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/rewards/log.ts

`dh-api rewards:remove`

rewards:remove

USAGE
  $ dh-api rewards:remove

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/rewards/remove.ts

`dh-api rewards:summary`

rewards:summary

USAGE
  $ dh-api rewards:summary

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/rewards/summary.ts

`dh-api services`

Service Control API

USAGE
  $ dh-api services

See code: src/commands/services/index.ts

`dh-api services:fivencoder`

services:fivencoder

USAGE
  $ dh-api services:fivencoder

OPTIONS
  -a, --ab=ab            Audio bitrate
  -a, --account=account  account to use
  -b, --batch=batch      Set if you pass a path to a directory to convert all files.
  -d, --dim=dim          Size of video in "400x300" format.
  -f, --format=format    format to return
  -n, --noemail=noemail  Send no emails at all.
  -p, --snap=snap        Number of seconds into video to take preview snapshot.
  -q, --quiet=quiet      Only send one email for a batch conversion.
  -r, --ar=ar            Audio sample rate
  -u, --url=url          Absolute URI of video or folder to convert.

See code: src/commands/services/fivencoder.ts

`dh-api services:progress`

services:progress

USAGE
  $ dh-api services:progress

OPTIONS
  -a, --account=account  account to use
  -f, --format=format    format to return
  -t, --token=token      service token to check

See code: src/commands/services/progress.ts

`dh-api user`

User API

USAGE
  $ dh-api user

OPTIONS
  -h, --help  show CLI help

See code: src/commands/user/index.ts

`dh-api user:add`

user:add

USAGE
  $ dh-api user:add

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/user/add.ts

`dh-api user:list`

user:list

USAGE
  $ dh-api user:list

OPTIONS
  -a, --account=account  account to use
  -f, --format=format    format to return

See code: src/commands/user/list.ts

`dh-api user:remove`

user:remove

USAGE
  $ dh-api user:remove

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/user/remove.ts

References

https://help.dreamhost.com/hc/en-us/articles/217560167-API_overview
https://oclif.io/

This site is open source. Improve this page.