Create
POST v1/master_key
Description
Create master key.
Normal Response Codes
201
HTTP Error Codes
400 401 403 404 409 500 503
Detail Codes
Request
| Parameter | Type | JSON Type | Description | Default | Mandatory | Deprecated |
|---|---|---|---|---|---|---|
| name | NsString | string | Name of the master key. The only allowed value is "default". Plain string. | 'default' | 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 |
JSON Request
Response
| Parameter | Type | JSON Type | Description | Deprecated |
|---|---|---|---|---|
| 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'. |
JSON Response