FIfiles
file_actions
File Actions

Encrypt a file with GPG and save it to a destination path.

Changed on

Encrypt a file with GPG and save it to a destination path.

post/file_actions/gpg_encrypt/{path}

Request

  • Base URL
    https://app.files.com/api/rest/v1
  • URL
    https://app.files.com/api/rest/v1/file_actions/gpg_encrypt/{path}
  • Auth
    none declared

Path parameters

pathstring required

Path to operate on.

Request body multipart/form-data

destinationstring required

Destination file path for the encrypted file.

gpg_key_idsinteger[]

GPG Key IDs to encrypt with.

gpg_key_partner_idinteger

Partner ID whose GPG keys should be used for encryption.

signing_key_idinteger

Optional GPG Key ID to sign with.

armorboolean

Output ASCII-armored encrypted data.

overwriteboolean

Overwrite existing file in the destination?

Response

The FileActions object.

statusstring

Status of file operation.

file_migration_idinteger

If status is pending, this is the id of the File Migration to check for status updates. Delete actions include it whenever the deletion runs as a File Migration, including while it is processing.

Example response

{
  "status": "pending",
  "file_migration_id": 1
}

Changes