# 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 ---"
}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://developers.couchdrop.io/administration/automations/actions/pgp-encrypt.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.