Start the storage encryption process

POST /api/2.0/settings/encryption/start

Request

Starts the storage encryption process.

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Content-Typeenum of string

Can be one of: application/json, application/*+json, text/json.

Body

Storage encryption request parameters

notifyUsersboolean

Specifies if the users will be notified about the encryption process or note

Examples

POST /api/2.0/settings/encryption/start HTTP/1.1
Accept: application/json
Content-Length: 25
Content-Type: application/json
Host: example.com

{
  "notifyUsers": true
}

curl --request POST \
  --url https://example.com/api/2.0/settings/encryption/start \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "notifyUsers": true
}'

Responses

200

Boolean value: true if the operation is successful

401

Unauthorized

403

Forbidden