npm package: @heroku-cli/plugin-mtls
Description: heroku mtls cli
Author: Heroku
Latest version: 1.0.2

# Heroku CLI MTLS Plugin

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
![GitHub Actions CI](https://github.com/heroku/heroku-mtls-cli/actions/workflows/ci.yml/badge.svg)

<!-- toc -->
* [Heroku CLI MTLS Plugin](#heroku-cli-mtls-plugin)
* [Installation](#installation)
* [Commands](#commands)
<!-- tocstop -->
# Installation
```sh-session
$ heroku plugins:install @heroku-cli/plugin-mtls
```
# 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:delete ADDON`](#heroku-datamtlsdelete-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 add-on

```
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 add-on

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

_See code: [src/commands/data/mtls/index.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.2/src/commands/data/mtls/index.ts)_

## `heroku data:mtls:certificates ADDON`

get the certificates for your mTLS enabled add-on

```
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 add-on

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

_See code: [src/commands/data/mtls/certificates/index.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.2/src/commands/data/mtls/certificates/index.ts)_

## `heroku data:mtls:certificates:create ADDON`

create a new certificate for your mTLS enabled add-on

```
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 add-on

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

_See code: [src/commands/data/mtls/certificates/create.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.2/src/commands/data/mtls/certificates/create.ts)_

## `heroku data:mtls:certificates:delete ADDON`

delete a specific certificate for your mTLS enabled add-on

```
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 add-on

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](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.2/src/commands/data/mtls/certificates/delete.ts)_

## `heroku data:mtls:certificates:download ADDON`

download your certificate bundle for your mTLS add-on

```
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 add-on

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](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.2/src/commands/data/mtls/certificates/download.ts)_

## `heroku data:mtls:certificates:get ADDON`

get a specific certificate for your mTLS enabled add-on

```
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 add-on

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](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.2/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](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.2/src/commands/data/mtls/create.ts)_

## `heroku data:mtls:delete ADDON`

disable mTLS for your add-on

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

ARGUMENTS
  ADDON  addon

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

DESCRIPTION
  disable mTLS for your add-on

ALIASES
  $ heroku data:mtls:delete

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

## `heroku data:mtls:destroy ADDON`

disable mTLS for your add-on

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

ARGUMENTS
  ADDON  addon

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

DESCRIPTION
  disable mTLS for your add-on

ALIASES
  $ heroku data:mtls:delete

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

_See code: [src/commands/data/mtls/destroy.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.2/src/commands/data/mtls/destroy.ts)_

## `heroku data:mtls:ip-rules ADDON`

get the IP Rules for your mTLS enabled add-on

```
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 add-on

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

_See code: [src/commands/data/mtls/ip-rules/index.ts](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.2/src/commands/data/mtls/ip-rules/index.ts)_

## `heroku data:mtls:ip-rules:create ADDON`

create a new IP Rule for your mTLS enabled add-on

```
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 a new IP Rule for your mTLS enabled add-on

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](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.2/src/commands/data/mtls/ip-rules/create.ts)_

## `heroku data:mtls:ip-rules:delete ADDON`

delete a specific IP Rule for your mTLS enabled add-on

```
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 add-on

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](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.2/src/commands/data/mtls/ip-rules/delete.ts)_

## `heroku data:mtls:ip-rules:get ADDON`

get the a specific IP Rule for your mTLS enabled add-on

```
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 the a specific IP Rule for your mTLS enabled add-on

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](https://github.com/heroku/heroku-cli-plugin-mtls/blob/v1.0.2/src/commands/data/mtls/ip-rules/get.ts)_
<!-- commandsstop -->