@heroku-cli/plugin-mtls

heroku mtls cli

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@heroku-cli/plugin-mtls
0.8.17 months ago3 years agoMinified + gzip package size for @heroku-cli/plugin-mtls in KB

Readme

heroku-mtls-cli
heroku mtls cli
oclif Version CircleCI Downloads/week License
Usage
```sh-session $ npm install -g @heroku-cli/plugin-mtls $ heroku COMMAND running command... $ heroku (-v|--version|version) @heroku-cli/plugin-mtls/0.8.1 darwin-x64 node-v14.18.0 $ heroku --help COMMAND USAGE $ heroku COMMAND ...
<!-- usagestop -->
# Commands
<!-- commands -->
* [`heroku data:mtls [ADDON]`](#heroku-datamtls-addon)
* [`heroku data:mtls:certificates [ADDON]`](#heroku-datamtlscertificates-addon)
* [`heroku data:mtls:certificates:create [ADDON]`](#heroku-datamtlscertificatescreate-addon)
* [`heroku data:mtls:certificates:delete [ADDON]`](#heroku-datamtlscertificatesdelete-addon)
* [`heroku data:mtls:certificates:download [ADDON]`](#heroku-datamtlscertificatesdownload-addon)
* [`heroku data:mtls:certificates:get [ADDON]`](#heroku-datamtlscertificatesget-addon)
* [`heroku data:mtls:create [ADDON]`](#heroku-datamtlscreate-addon)
* [`heroku data:mtls:destroy [ADDON]`](#heroku-datamtlsdestroy-addon)
* [`heroku data:mtls:ip-rules [ADDON]`](#heroku-datamtlsip-rules-addon)
* [`heroku data:mtls:ip-rules:create [ADDON]`](#heroku-datamtlsip-rulescreate-addon)
* [`heroku data:mtls:ip-rules:delete [ADDON]`](#heroku-datamtlsip-rulesdelete-addon)
* [`heroku data:mtls:ip-rules:get [ADDON]`](#heroku-datamtlsip-rulesget-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](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v0.8.1/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](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v0.8.1/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](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v0.8.1/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](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v0.8.1/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](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v0.8.1/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](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v0.8.1/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](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v0.8.1/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](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v0.8.1/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](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v0.8.1/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](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v0.8.1/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](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v0.8.1/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