REST endpoints: Encryption

These endpoints mirror the CLI commands described in E, 0Encryption. Each endpoint runs the CLI command named under its heading, so the behavior, defaults, and restrictions are the same; this page lists how to call it over REST.

Conventions that apply to every endpoint (request format, the async and outputType parameters, and the response envelope) are in Requests and responses. In the tables below, Required is Yes when the parameter must always be supplied, No when it is optional, and Depends when it is required only in some combinations (for example, either an application and volume, or a consistency group ID); the CLI chapter for the same command explains the combinations.

`GET /applications/encryption/encryption_key_example`

Generate an example encryption key that can be used for encrypting a consistency group.

CLI command: applications encryption encryption_key_example

This endpoint takes no parameters.

Response: the command output, in the format selected by outputType.

`PUT /applications/encryption/supply_encryption_key`

Supply an encryption key to allow an encrypted consistency group to load.

CLI command: applications encryption supply_encryption_key

Body fields (JSON)

Name	Type	Required	Description
`Cgid`	integer	Depends	The id of the encrypted consistency group to open.
`Application`	string	Depends	The application which contains the consistency group to open.
`Volume`	string	Depends	The volume which contains the encrypted consistency group to open.
`EncryptionKey`	string	Yes	Open the encrypted consistency group using the supplied key.