@heroku-cli/plugin-mtls

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: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]

OPTIONS
  -a, --app=app  (required) app to run command against

EXAMPLE
  $ heroku data:mtls postgresql-sushi-12345

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]

OPTIONS
  -a, --app=app  (required) app to run command against

EXAMPLE
  $ heroku data:mtls:ip-rules postgresql-sushi-12345

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]

OPTIONS
  -a, --app=app  (required) app to run command against

EXAMPLE
  $ heroku data:mtls:certificates:create postgresql-sushi-12345

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]

OPTIONS
  -a, --app=app  (required) app to run command against
  --id=id        (required) id of certificate

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

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]

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

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

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]

OPTIONS
  -a, --app=app  (required) app to run command against
  --id=id        (required) id of IP Rule

EXAMPLE
  $ heroku data:mtls:certificates:create postgresql-sushi-12345 --id "1862ec85-fdc1-47b3-924e-a91d26ca3a7c"

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]

OPTIONS
  -a, --app=app  (required) app to run command against

EXAMPLE
  $ heroku data:mtls:create postgresql-sushi-12345

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

heroku data:mtls:destroy [ADDON]

destroy MTLS configuration on your addon

USAGE
  $ heroku data:mtls:destroy [ADDON]

OPTIONS
  -a, --app=app  (required) app to run command against

ALIASES
  $ heroku data:mtls:delete

EXAMPLE
  $ heroku data:mtls:destroy postgresql-sushi-12345

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]

OPTIONS
  -a, --app=app  (required) app to run command against

EXAMPLE
  $ heroku data:mtls:ip-rules postgresql-sushi-12345

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]

OPTIONS
  -a, --app=app              (required) app to run command against
  --cidr=cidr                (required)
  --description=description

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

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]

OPTIONS
  -a, --app=app  (required) app to run command against
  --cidr=cidr    cidr of IP Rule
  --id=id        id of IP Rule

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

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]

OPTIONS
  -a, --app=app  (required) app to run command against
  --id=id        (required) id of IP Rule

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

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