Skip to content

put_encryption_instance

Alberto Gonzalez edited this page Oct 29, 2015 · 1 revision

(PUT)/encryption/enable-instance/{instance-ids}/?sid={sid}

(PUT)/encryption/disable-instance/{instance-ids}/?sid={sid}

Description

Updates the encryption setting for the instance ids passed in, based on the action. The enable-instance action on the encryption flag, while disable-instance turns it off. These values will be returned in the is_encrypted property returned by the (GET)/assets API.

Request

Syntax

PUT /api/encryption/{action}/{instance-ids}/?sid={sid}
Host: <server host name>
Accept: application/json
AuthToken: <authentication token returned from authenticate>

Parameters

Available actions are:

  • enable-instance - encrypt backups for this instance
  • disable-instance - do not encrypt backups for this instance

Response

Parameters

200 (HTTP OK) on success.

Examples

Sample Request

PUT /api/encryption/enable-instance/3,5,10,22/?sid=1
Host: <server host name>
Accept: application/json
AuthToken: 8a00sjerhterqerjlqkjlk443l4j56869h4f_)(fjdkasHHHHHkdal324

Sample Response

HTTP Status: 200 (OK)

Failed encryption setting changes will return HTTP Status 500 with a result object with an error message and KB link as defined here

Clone this wiki locally