List of endpoints for configuring the policies, options and connection rules of VNC connections.
URL
GET https://<IP-address-of-SPS>/api/configuration/vnc
Cookies
| session_id |
Contains the authentication token of the user |
Required |
The value of the session ID cookie received from the REST server in the authentication response, for example, a1f71d030e657634730b9e887cb59a5e56162860. For details on authentication, see Authenticate to the SPS REST API.
NOTE: This session ID refers to the connection between the REST client and the SPS REST API. It is not related to the sessions that SPS records (and which also have a session ID, but in a different format).. |
Sample request
The following command lists the available settings for configuring for VNC connections.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/vnc
Response
The following is a sample response received when listing the configuration settings.
For details of the meta object, see Message format.
{
"items": [
{
"key": "channel_policies",
"meta": {
"href": "/api/configuration/vnc/channel_policies"
}
},
{
"key": "connections",
"meta": {
"href": "/api/configuration/vnc/connections"
}
},
{
"key": "options",
"meta": {
"href": "/api/configuration/vnc/options"
}
}
],
"meta": {
"first": "/api/configuration/aaa",
"href": "/api/configuration/vnc",
"last": "/api/configuration/x509",
"next": "/api/configuration/x509",
"parent": "/api/configuration",
"previous": "/api/configuration/troubleshooting",
"transaction": "/api/transaction"
}
}
| channel_policies |
List of the default and custom channel policies. |
|
connections |
List of the VNC connection policies. |
| options |
List of global VNC options that affect all connections. |
Status and error codes
The following table lists the typical status and error codes for this request. For a complete list of error codes, see Application level error codes.
| 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 was attempted to be accessed, but could not be retrieved. |
| 403 |
Unauthorized |
The requested resource cannot be retrieved because the client is not authorized to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved. |
| 404 |
NotFound |
The requested object does not exist. |
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/
Cookies
| session_id |
Contains the authentication token of the user |
Required |
The value of the session ID cookie received from the REST server in the authentication response, for example, a1f71d030e657634730b9e887cb59a5e56162860. For details on authentication, see Authenticate to the SPS REST API.
NOTE: This session ID refers to the connection between the REST client and the SPS REST API. It is not related to the sessions that SPS records (and which also have a session ID, but in a different format).. |
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
Cookies
| session_id |
Contains the authentication token of the user |
Required |
The value of the session ID cookie received from the REST server in the authentication response, for example, a1f71d030e657634730b9e887cb59a5e56162860. For details on authentication, see Authenticate to the SPS REST API.
NOTE: This session ID refers to the connection between the REST client and the SPS REST API. It is not related to the sessions that SPS records (and which also have a session ID, but in a different format).. |
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.
For details of the meta object, see Message format.
{
"body": {
"audit": {
"cleanup": {
"enabled": false
},
"timestamping": {
"selection": "local",
"signing_interval": 30
}
},
"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"
}
}
| key |
|
|
Top level item |
Contains the ID of the endpoint. |
| body |
|
|
Top level item |
Contains the elements of the global VNC options. |
|
audit |
|
Top level item |
Contains settings for timestamping and cleanup. |
|
service |
|
Top level item |
Global setting to enable VNC connections, and specify the logging detail. |
|
|
enabled |
boolean |
Set to true to enable VNC connections. |
|
|
log_level |
int |
Defines the logging detail of VNC connections. |
| cleanup |
|
|
Top level item |
Global retention settings for VNC connection metadata. To configure retention time for a specific connection policy, use the archive_cleanup_policy element at the endpoint of the policy instead. |
|
channel_database_cleanup_days |
|
int |
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. |
| timestamping |
|
|
Top level item |
Global timestamping settings for VNC connections. |
|
selection |
|
string |
Configures local or remote timestamping.
|
|
server_url |
|
string |
Required for remote timestamping.
The URL of the timestamping server. Note that HTTPS and password-protected connections are not supported. |
|
oid |
|
Top level item |
The Object Identifier of the policy used for timestamping. |
|
|
enabled |
boolean |
Required for remote timestamping.
Set to true to configure the Object Identifier of the timestamping policy on the timestamping remote server. |
|
|
policy_oid |
string |
Required if the oid is enabled.
The Object Identifier of the timestamping policy on the remote timestamping server. |
|
signing_interval |
|
int |
Time interval for timestamping open connections, in seconds. |
Examples:
Set SPS as the timestamping server:
{
"audit": {
"cleanup": {
"enabled": false
},
"timestamping": {
"selection": "local",
"signing_interval": 30
}
},
"service": {
"enabled": true,
"log_level": 4
}
}
Enable cleanup, and set it to occur every 10 days:
{
"audit": {
"cleanup": {
"channel_database_cleanup_days": 10,
"enabled": true
},
"timestamping": {
"selection": "local",
"signing_interval": 30
}
},
"service": {
"enabled": true,
"log_level": 4
}
}
Change timestamping to a remote server, without specifying a timestamping policy:
{
"audit": {
"cleanup": {
"channel_database_cleanup_days": 10,
"enabled": true
},
"timestamping": {
"oid": {
"enabled": false
},
"selection": "remote",
"server_url": "<url-of-timestamping-server>",
"signing_interval": 30
}
},
"service": {
"enabled": true,
"log_level": 4
}
}
Change timestamping to a remote server, and specify the 1.2.3 timestamping policy:
{
"audit": {
"cleanup": {
"channel_database_cleanup_days": 10,
"enabled": true
},
"timestamping": {
"oid": {
"enabled": true,
"policy_oid": "1.2.3"
},
"selection": "remote",
"server_url": "<url-of-timestamping-server>",
"signing_interval": 30
}
},
"service": {
"enabled": true,
"log_level": 4
}
}
Modify global VNC settings
To modify global VNC settings, you have to:
-
Open a transaction.
For more information, see Open a transaction.
-
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 . The elements of the audit item are described in Elements of audit.
-
Commit your changes.
For more information, see Commit a transaction.
Status and error codes
The following table lists the typical status and error codes for this request. For a complete list of error codes, see Application level error codes.
| 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 was attempted to be accessed, but could not be retrieved. |
| 403 |
Unauthorized |
The requested resource cannot be retrieved because the client is not authorized to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved. |
| 404 |
NotFound |
The requested object does not exist. |
