@heroku-cli/plugin-mtls v1.0.0

Heroku CLI MTLS Plugin

• Heroku CLI MTLS Plugin
• Installation
• Commands

Installation

$ heroku plugins:install @heroku-cli/plugin-mtls

Commands

• heroku data:mtls ADDON
• heroku data:mtls:certificates ADDON
• heroku data:mtls:certificates:create ADDON
• heroku data:mtls:certificates:delete ADDON
• heroku data:mtls:certificates:download ADDON
• heroku data:mtls:certificates:get ADDON
• heroku data:mtls:create ADDON
• heroku data:mtls:delete ADDON
• heroku data:mtls:destroy ADDON
• heroku data:mtls:ip-rules ADDON
• heroku data:mtls:ip-rules:create ADDON
• heroku data:mtls:ip-rules:delete ADDON
• heroku data:mtls:ip-rules:get ADDON

heroku data:mtls ADDON

get the status of MTLS for your addon

USAGE
  $ heroku data:mtls ADDON -a <value>

ARGUMENTS
  ADDON  addon

FLAGS
  -a, --app=<value>  (required) app to run command against

DESCRIPTION
  get the status of MTLS for your addon

EXAMPLES
  $ heroku data:mtls postgresql-sushi-12345 -a example-app

See code: src/commands/data/mtls/index.ts

heroku data:mtls:certificates ADDON

get the certificates for your MTLS enabled addon

USAGE
  $ heroku data:mtls:certificates ADDON -a <value>

ARGUMENTS
  ADDON  addon

FLAGS
  -a, --app=<value>  (required) app to run command against

DESCRIPTION
  get the certificates for your MTLS enabled addon

EXAMPLES
  $ heroku data:mtls:certificates postgresql-sushi-12345 -a example-app

See code: src/commands/data/mtls/certificates/index.ts

heroku data:mtls:certificates:create ADDON

create a new certificate for your MTLS enabled addon

USAGE
  $ heroku data:mtls:certificates:create ADDON -a <value>

ARGUMENTS
  ADDON  addon

FLAGS
  -a, --app=<value>  (required) app to run command against

DESCRIPTION
  create a new certificate for your MTLS enabled addon

EXAMPLES
  $ heroku data:mtls:certificates:create postgresql-sushi-12345 -a example-app

See code: src/commands/data/mtls/certificates/create.ts

heroku data:mtls:certificates:delete ADDON

delete a specific certificate for your MTLS enabled addon

USAGE
  $ heroku data:mtls:certificates:delete ADDON -a <value> --id <value>

ARGUMENTS
  ADDON  addon

FLAGS
  -a, --app=<value>  (required) app to run command against
      --id=<value>   (required) id of certificate

DESCRIPTION
  delete a specific certificate for your MTLS enabled addon

EXAMPLES
  $ heroku data:mtls:certificates:delete postgresql-sushi-12345 --id "1862ec85-fdc1-47b3-924e-a91d26ca3a7c" -a example-app

See code: src/commands/data/mtls/certificates/delete.ts

heroku data:mtls:certificates:download ADDON

download your certificate bundle for your mTLS addon

USAGE
  $ heroku data:mtls:certificates:download ADDON -a <value> --prefix <value> [--dir <value>] [--id <value>]

ARGUMENTS
  ADDON  addon

FLAGS
  -a, --app=<value>     (required) app to run command against
      --dir=<value>     directory to download files to. defaults to HOME:/.postgresql
      --id=<value>      ID of certificate to download
      --prefix=<value>  (required) prefix to put in front of downloaded file names

DESCRIPTION
  download your certificate bundle for your mTLS addon

EXAMPLES
  $ heroku data:mtls:certificates:download postgresql-sushi-12345 --id "3559a4df-2c82-4473-86cf-181310a6ef4f" -a example-app

  $ heroku data:mtls:certificates:download postgresql-sushi-12345 --id "3559a4df-2c82-4473-86cf-181310a6ef4f" --dir "./folder" -a example-app

  $ heroku data:mtls:certificates:download postgresql-sushi-12345 --id "3559a4df-2c82-4473-86cf-181310a6ef4f --prefix "prefix_" -a example-app

See code: src/commands/data/mtls/certificates/download.ts

heroku data:mtls:certificates:get ADDON

get a specific certificate for your MTLS enabled addon

USAGE
  $ heroku data:mtls:certificates:get ADDON -a <value> --id <value>

ARGUMENTS
  ADDON  addon

FLAGS
  -a, --app=<value>  (required) app to run command against
      --id=<value>   (required) id of IP Rule

DESCRIPTION
  get a specific certificate for your MTLS enabled addon

EXAMPLES
  $ heroku data:mtls:certificates:get postgresql-sushi-12345 --id "1862ec85-fdc1-47b3-924e-a91d26ca3a7c" -a example-app

See code: src/commands/data/mtls/certificates/get.ts

heroku data:mtls:create ADDON

enable MTLS for your addon

USAGE
  $ heroku data:mtls:create ADDON -a <value>

ARGUMENTS
  ADDON  addon

FLAGS
  -a, --app=<value>  (required) app to run command against

DESCRIPTION
  enable MTLS for your addon

EXAMPLES
  $ heroku data:mtls:create postgresql-sushi-12345 -a example-app

See code: src/commands/data/mtls/create.ts

heroku data:mtls:delete ADDON

destroy MTLS configuration on your addon

USAGE
  $ heroku data:mtls:delete ADDON -a <value>

ARGUMENTS
  ADDON  addon

FLAGS
  -a, --app=<value>  (required) app to run command against

DESCRIPTION
  destroy MTLS configuration on your addon

ALIASES
  $ heroku data:mtls:delete

EXAMPLES
  $ heroku data:mtls:destroy postgresql-sushi-12345 -a example-app

heroku data:mtls:destroy ADDON

destroy MTLS configuration on your addon

USAGE
  $ heroku data:mtls:destroy ADDON -a <value>

ARGUMENTS
  ADDON  addon

FLAGS
  -a, --app=<value>  (required) app to run command against

DESCRIPTION
  destroy MTLS configuration on your addon

ALIASES
  $ heroku data:mtls:delete

EXAMPLES
  $ heroku data:mtls:destroy postgresql-sushi-12345 -a example-app

See code: src/commands/data/mtls/destroy.ts

heroku data:mtls:ip-rules ADDON

get the IP Rules for your MTLS enabled addon

USAGE
  $ heroku data:mtls:ip-rules ADDON -a <value>

ARGUMENTS
  ADDON  addon

FLAGS
  -a, --app=<value>  (required) app to run command against

DESCRIPTION
  get the IP Rules for your MTLS enabled addon

EXAMPLES
  $ heroku data:mtls:ip-rules postgresql-sushi-12345 -a example-app

See code: src/commands/data/mtls/ip-rules/index.ts

heroku data:mtls:ip-rules:create ADDON

create an IP Rule for your MTLS enabled addon

USAGE
  $ heroku data:mtls:ip-rules:create ADDON -a <value> --cidr <value> [--description <value>]

ARGUMENTS
  ADDON  addon

FLAGS
  -a, --app=<value>          (required) app to run command against
      --cidr=<value>         (required)
  --description=<value>

DESCRIPTION
  create an IP Rule for your MTLS enabled addon

EXAMPLES
  $ heroku data:mtls:ip-rules:create postgresql-sushi-12345 --cidr "1.2.3.4/32" --description "home IP address" -a example-app

See code: src/commands/data/mtls/ip-rules/create.ts

heroku data:mtls:ip-rules:delete ADDON

delete a specific IP Rule for your MTLS enabled addon

USAGE
  $ heroku data:mtls:ip-rules:delete ADDON -a <value> [--cidr <value>] [--id <value>]

ARGUMENTS
  ADDON  addon

FLAGS
  -a, --app=<value>   (required) app to run command against
      --cidr=<value>  cidr of IP Rule
      --id=<value>    id of IP Rule

DESCRIPTION
  delete a specific IP Rule for your MTLS enabled addon

EXAMPLES
  $ heroku data:mtls:ip-rules:delete postgresql-sushi-12345 --id "1862ec85-fdc1-47b3-924e-a91d26ca3a7c" -a example-app

See code: src/commands/data/mtls/ip-rules/delete.ts

heroku data:mtls:ip-rules:get ADDON

get a specific IP Rule for your MTLS enabled addon

USAGE
  $ heroku data:mtls:ip-rules:get ADDON -a <value> --id <value>

ARGUMENTS
  ADDON  addon

FLAGS
  -a, --app=<value>  (required) app to run command against
      --id=<value>   (required) id of IP Rule

DESCRIPTION
  get a specific IP Rule for your MTLS enabled addon

EXAMPLES
  $ heroku data:mtls:ip-rules:get postgresql-sushi-12345 --id "1862ec85-fdc1-47b3-924e-a91d26ca3a7c" -a example-app

See code: src/commands/data/mtls/ip-rules/get.ts