GuardPoints Report
The GuardPoints Report shows the GuardPoints applied to the CTE clients available on the CipherTrust Manager. A client can have multiple GuardPoints. Similarly, a GuardPoint can be applied to multiple clients.
Generating the Report
Use the get /v1/transparent-encryption/reports/guardpoints API to generate the report. Columns in the report can be filtered using the request query parameters.
Syntax
curl -k '<IP>/api/v1/transparent-encryption/reports/guardpoints/?sort=client_name&skip=0&limit=10' -H 'Authorization: Bearer AUTHTOKEN' --compressed
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| AUTHTOKEN | string | Authorization token. |
Request Query Parameters
| Parameter | Type | Description |
|---|---|---|
| client_name | string | (optional) Name of the client. If not specified, the report will contain policies applied to all clients. |
| policy_name | string | (optional) Name of the policy applied to the client. If not specified, the report will contain all policies applied to the specified clients. |
| guard_point_type | string | (optional) Type of the device to protect. The options are: • directory_auto• directory_manual• cloudstorage_auto• cloudstorage_manual• rawdevice_auto• rawdevice_manualIf not specified, the report will contain GuardPoints of all types. |
| guard_enabled | string | (optional) Whether the GuardPoint is enabled - true or false. If not specified, the report will contain all records irrespective of whether a GuardPoint is enabled or not. |
| guard_path | string | (optional) Path where the GuardPoint is applied. If not specified, the report will contain GuardPoints applied on all paths. |
| sort | string | Comma-delimited list of columns to sort the results. Multiple fields are sorted by multi-field sort. By default, the results are sorted in alphabetic ascending order. To change the sort order, precede the field by a - (minus) sign. |
| skip | integer | Number of records to skip. For example, if "skip":5 is specified, the first five records will not be displayed in the output. |
| limit | integer | Numbers of records to display. For example, if "limit":10 is specified, then the next 10 records (after skipping the number of records specified in the skip parameter) will be displayed in the output. |
Example Request
curl -k 'https://127.0.0.1/api/v1/transparent-encryption/reports/guardpoints/?sort=client_name&skip=0&limit=10' -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIwNjZjMzJkZi1mZTMyLTRhZTctYThkYi1lMDZhZjYwMGQ4ZjAiLCJzdWIiOiJsb2NhbHxiNjA5ZjU3MC1hYjZmLTQzZDQtOWVjYi04ODVlNzRiZWYyODUiLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiYmNlNTE1NzktMzk3NC00YWVjLTllZmItMTQ1MzA2NGNlYjA2Iiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6ImViOTM5YWVhLTBhNmQtNGM5My05MTFkLTg2YmNiMThlNjEyNSIsImlhdCI6MTYwNjI4MDAyMSwiZXhwIjoxNjA2MjgwMzIxfQ.AP0DFYeaYDFzKtIb_A_hFjtBH33aphPIwTElBDKDh34' --compressed
Example Response
{
"skip": 0,
"limit": 10,
"total": 3,
"resources": [
{
"client_name": "client_001",
"policy_name": "hr_policy",
"guard_path": "/usr/bin",
"guard_enabled": "true",
"guard_point_type": "directory_auto",
},
{
"client_name": "client_002",
"policy_name": "it_policy",
"guard_path": "c:\\test_policy",
"guard_enabled": "true",
"guard_point_type": "directory_auto",
},
{
"client_name": "client_003",
"policy_name": "test_policy",
"guard_path": "/usr/test",
"guard_enabled": "true",
"guard_point_type": "directory_auto",
}
]
}
The output shows the mapping of clients with the GuardPoints applied to them. You can download the report as a PDF or CSV document, as required. Refer to Downloading the Report.
Response Codes
| Response Code | Description |
|---|---|
| 2xx | Success |
| 4xx | Client errors |
| 5xx | Server errors |
Refer to HTTP status codes for details.
Downloading the Report
Use the get /v1/transparent-encryption/reports/guardpoints/download API to download the report as a PDF or CSV document.
Syntax
curl -k '<IP>/api/v1/transparent-encryption/reports/guardpoints/download/?report_type=<report_type>' -H 'Authorization: Bearer AUTHTOKEN' --compressed
Request Parameters
| Parameter | Type | Description |
|---|---|---|
| AUTHTOKEN | string | Authorization token. |
| report_type | string | (Mandatory) Format of the report to download. The options are pdf and csv. |
Request Query Parameters
Refer to Request Query Parameters. You can specify the fields to be omitted from the downloaded report in the omit_fields parameter. The fields that can be omitted are guard_point_type and guard_enabled.
| Parameter | Type | Description |
|---|---|---|
| guard_point_type | string | Type of the device to protect. |
| guard_enabled | string | Whether the GuardPoint is enabled. |
Example Request
curl -k 'https://127.0.0.1/api/v1/transparent-encryption/reports/guardpoints/download/?report_type=pdf&sort=client_name&skip=0&limit=10' -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIwNjZjMzJkZi1mZTMyLTRhZTctYThkYi1lMDZhZjYwMGQ4ZjAiLCJzdWIiOiJsb2NhbHxiNjA5ZjU3MC1hYjZmLTQzZDQtOWVjYi04ODVlNzRiZWYyODUiLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiYmNlNTE1NzktMzk3NC00YWVjLTllZmItMTQ1MzA2NGNlYjA2Iiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6ImViOTM5YWVhLTBhNmQtNGM5My05MTFkLTg2YmNiMThlNjEyNSIsImlhdCI6MTYwNjI4MDAyMSwiZXhwIjoxNjA2MjgwMzIxfQ.AP0DFYeaYDFzKtIb_A_hFjtBH33aphPIwTElBDKDh34' --compressed
CSV
If you specified report_type as csv, the report is downloaded as a CSV file named, cte_guardpoints_<TIMESTAMP>.csv, for example, cte_guardpoints_2021-01-12T07_15_38Z.csv.
If you specified report_type as pdf, the report is downloaded in a PDF document named, cte_guardpoints_<TIMESTAMP>.pdf, for example, cte_guardpoints_2021-01-12T07_17_21Z.pdf.
The downloaded PDF document shows the Report Name as GuardPoints Report and time the report is Generated At.
Viewing the Report
Based on the parameters specified during the API call, the downloaded report shows all or some of the following columns:
| Column | Description |
|---|---|
| Client Name | Name of the client on the CipherTrust Manager. |
| Policy Name | Name of the applied policy. |
| Guard Path | Path where the GuardPoint is applied. |
| Guard Type | Type of the GuardPoint. |
| Guard Enabled | Whether a GuardPoint is enabled. |
