Connection policies determine if a server can be accessed from a particular client. Connection policies reference other resources (policies, usergroups, keys) that must be configured and available before creating a connection policy.
|
|
Caution:
The connection policies of this protocol are available in READ-ONLY mode on the REST API. Also, the returned data is incomplete, it does not include any protocol-specific settings, only the parameters that are common to every supported protocol.
To modify the connection policies of this protocol, you must use the SPS web interface.
Using the REST API, you can modify the connection policies of the RDP and SSH protocols. |
URL
GET https://<IP-address-of-SPS>/api/configuration/vnc/connections/
Sample request
The following command lists VNC connection policies.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/vnc/connections/
The following command retrieves the properties of a specific policy.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/vnc/connections/<connection-key>
List of options that affect all VNC connections.
URL
GET https://<IP-address-of-SPS>/api/configuration/vnc/options
Sample request
The following command lists global VNC options.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/vnc/options
Response
The following is a sample response received when listing global VNC options.
{
"body": {
"channel_database_cleanup": {
"enabled": false
},
"service": {
"enabled": false
}
}
}
"key": "options",
"meta": {
"first": "/api/configuration/vnc/channel_policies",
"href": "/api/configuration/vnc/options",
"last": "/api/configuration/vnc/options",
"next": null,
"parent": "/api/configuration/vnc",
"previous": "/api/configuration/vnc/channel_policies",
"transaction": "/api/transaction"
}
}
| key |
|
Top level item |
Contains the ID of the endpoint. |
| body |
|
Top level item |
Contains the elements of the global VNC options. |
| |
channel_database_cleanup |
Top level item |
Contains settings for database cleanup. |
| |
service |
Top level item |
Global setting to enable VNC connections, and specify the logging detail. |
| days |
integer |
Applies only if enabled is set to true.
Global retention time for the metadata of VNC connections, in days. Must exceed the retention time of the archiving policy (or policies) used for VNC connections, and the connection-specific database cleanup times (if configured). |
|
enabled |
boolean |
To enable the global cleanup of VNC connection metadata, set this element to true. |
| log_level |
integer |
Applies only if enabled is set to true.
Defines the logging detail of VNC connections. |
|
enabled |
boolean |
Set to true to enable VNC connections. |
Examples
Querying the full list of global VNC options:
{
"body": {
"channel_database_cleanup": {
"enabled": true,
"days": 365
},
"service": {
"enabled": true,
"log_level": 4
}
}
"key": "options",
"meta": {
"first": "/api/configuration/vnc/channel_policies",
"href": "/api/configuration/vnc/options",
"last": "/api/configuration/vnc/options",
"next": null,
"parent": "/api/configuration/vnc",
"previous": "/api/configuration/vnc/channel_policies",
"transaction": "/api/transaction"
}
}
Modify global VNC settings
To modify global VNC settings, you have to:
-
Modify the JSON object of the global VNC settings endpoint.
PUT the modified JSON object to the https://<IP-address-of-SPS>/api/configuration/vnc/options endpoint.
You can find a detailed description of the available parameters listed in Element.
For more information about the elements of the channel_database_cleanup item, see Elements of channel_database_cleanup.
For more information about the elements of the service item, see Elements of service.
| 201 |
Created |
The new resource was successfully created. |
| 401 |
Unauthenticated |
The requested resource cannot be retrieved because the client is not authenticated and the resource requires authorization to access it. The details section contains the path that the SPS REST API attempted to access, but could not retrieve. |
| 403 |
Unauthorized |
The requested resource cannot be retrieved because the client is not authorized to access it. The details section contains the path that the SPS REST API attempted to access, but could not retrieve. |
| 404 |
NotFound |
The requested object does not exist. |
Search, download, and index sessions
The api/audit/sessions endpoint lists the recorded sessions (active and closed).
URL
GET https://<IP-address-of-SPS>/api/audit/sessions
