get_encryption

(GET)/encryption

Description

Returns the encryption information about the specified system.

Request

Syntax

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

Parameters

Optional filters include:

Filter	Description	Example
?sid={sid}	return only the encryption status on system id {sid}	GET /api/encryption/?sid=1

Response

200 success

Parameters

Index	Value	Type	Returned
state	encryption state	string	always

• | "on" - encryption is active and enabled, not persistent across reboots |
• | "persist" - encryption is active and enabled, and will persist across reboots |
• | "off" - encryption is not enabled | has_passphrase | the encryption passphrase has been set? | boolean | always

Examples

Sample Request

GET /api/encryption/?sid=2
Host: <server host name>
Accept: application/json
AuthToken: 8a00sjerhterqerjlqkjlk443l4j56869h4f_)(fjdkasHHHHHkdal324

Sample Response

{
    "data": {
        "system_id": 2,
        "system_name": "UEB-CentOS6-lmc",
        "state": "on",
        "has_passphrase": true
    }
}