> For the complete documentation index, see [llms.txt](https://developers.couchdrop.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.couchdrop.io/administration/automations/actions/pgp-encrypt.md).

# PGP Encrypt

**Required Fields**

| Key                                     | Description                                                                                                         |
| --------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| type                                    | The action type. Must be set as "pgp\_encrypt"                                                                      |
| pgp\_encrypt\_pub\_key                  | The public key you want to encrypt the file with.                                                                   |
| pgp\_sign\_with\_private\_key           | (Optional) If you want to sign the file with a private key after encrypting it, set this field to your private key. |
| pgp\_sign\_with\_private\_key\_password | (Optional) If you are signing the file with a private key, normally you need to specify a password for your key.    |

**Example**

```
{
    "type":"pgp_encrypt",
    "pgp_encrypt_pub_key":"--- BEGIN KEY ---... --- END KEY ---"
}
```
