Update

PUT v1/master_key/id

Description

Enable/disable the master key or change the passphrase to a new value, 'passphrase' attribute is always required. Updating 'active' attribute to enable or disable the master key. Updating 'new_passphrase' attribute to change the passphrase to a new value. Changing the activeness and the passphrase of the key are not allowed in the same update.

Normal Response Codes

200

HTTP Error Codes

400 401 403 404 409 500 503

Detail Codes

SM_invalid_arg_value

SM_invalid_path_variable

SM_invalid_query_param

SM_malformed_url

SM_missing_arg

SM_no_method_for_URL_pattern

SM_no_operation_found

SM_no_path_found

SM_unexpected_arg

SM_unexpected_query_param

SM_version_name

Request

Parameter	Type	JSON Type	Description	Mandatory
id	NsObjectID	string	Identifier of the master key. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.	true
name	NsString	string	Name of the master key. The only allowed value is "default". Plain string.	false
passphrase	NsPassphrase	string	Passphrase used to protect the master key, required during creation, enabling/disabling the key and change the passphrase to a new value. Encryption passphrase. String with size from 8 to 64 printable characters. Example: 'passphrase-91'.	true
new_passphrase	NsPassphrase	string	When changing the passphrase, this attribute specifies the new value of the passphrase. Encryption passphrase. String with size from 8 to 64 printable characters. Example: 'passphrase-91'.	false
active	NsBoolean	boolean	Whether the master key is active or not. Possible values: 'true', 'false'.	false

JSON Request

{}

Response

Parameter	Type	JSON Type	Description
id	NsObjectID	string	Identifier of the master key. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.
name	NsString	string	Name of the master key. The only allowed value is "default". Plain string.
active	NsBoolean	boolean	Whether the master key is active or not. Possible values: 'true', 'false'.