List of options that affect all MSSQL connections.
URL
GET https://<IP-address-of-SPS>/api/configuration/mssql/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 MSSQL options.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/mssql/options
Response
The following is a sample response received when listing global MSSQL 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/mssql/channel_policies",
"href": "/api/configuration/mssql/options",
"last": "/api/configuration/mssql/options",
"next": null,
"parent": "/api/configuration/mssql",
"previous": "/api/configuration/mssql/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 MSSQL options. |
|
audit |
|
Top level item |
Contains settings for timestamping and cleanup. |
|
service |
|
Top level item |
Global setting to enable MSSQL connections, and specify the logging detail. |
|
|
enabled |
boolean |
Set to true to enable MSSQL connections. |
|
|
log_level |
int |
Defines the logging detail of MSSQL connections. |
| cleanup |
|
|
Top level item |
Global retention settings for MSSQL 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 MSSQL connections, in days. Must exceed the retention time of the archiving policy (or policies) used for MSSQL connections, and the connection-specific database cleanup times (if configured). |
|
enabled |
|
boolean |
To enable the global cleanup of MSSQL connection metadata, set this element to true. |
| timestamping |
|
|
Top level item |
Global timestamping settings for MSSQL 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 MSSQL settings
To modify global MSSQL settings, you have to:
-
Open a transaction.
For more information, see Open a transaction.
-
Modify the JSON object of the global MSSQL settings endpoint.
PUT the modified JSON object to the https://<IP-address-of-SPS>/api/configuration/mssql/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. |
MSSQL settings policies define protocol-level settings for idle and session timeout. You can create multiple policies, and choose the appropriate one for each MSSQL connection.
URL
GET https://<IP-address-of-SPS>/api/configuration/mssql/settings_policies
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 MSSQL settings policies.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/mssql/settings_policies
The following command retrieves the properties of a specific policy.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/mssql/settings_policies/<policy-id>
Response
The following is a sample response received when listing MSSQL settings policies.
For details of the meta object, see Message format.
{
"items": [
{
"key": "-3040010",
"meta": {
"href": "/api/configuration/mssql/settings_policies/-3040010"
}
}
],
"meta": {
"first": "/api/configuration/mssql/channel_policies",
"href": "/api/configuration/mssql/settings_policies",
"last": "/api/configuration/mssql/settings_policies",
"next": null,
"parent": "/api/configuration/mssql",
"previous": "/api/configuration/mssql/options",
"transaction": "/api/transaction"
}
}
When retrieving the endpoint of a specific policy, the response is the following.
{
"body": {
"client_tls_security_settings": {
"cipher_strength": {
"selection": "recommended"
},
"minimum_tls_version": "TLSv1_2"
},
"name": "default",
"server_tls_security_settings": {
"cipher_strength": {
"selection": "recommended"
},
"minimum_tls_version": "TLSv1_2"
},
"session_timeout": 900,
"timeout": 300
},
"key": "-3040010",
"meta": {
"first": "/api/configuration/mssql/settings_policies/-3040010",
"href": "/api/configuration/mssql/settings_policies/-3040010",
"last": "/api/configuration/mssql/settings_policies/-3040010",
"next": null,
"parent": "/api/configuration/mssql/settings_policies",
"previous": null,
"transaction": "/api/transaction"
}
}
| key |
|
string |
Top level element, contains the ID of the policy. |
| body |
|
Top level element (string) |
The elements of the MSSQL settings policy. |
|
client_tls_security_settings |
JSON object |
Configures TLS security settings on the client side. |
|
name |
string |
Name of the MSSQL settings policy. Cannot contain whitespace. |
|
server_tls_security_settings |
JSON object |
Configures TLS security settings on the server side. |
|
timeout |
int |
Idle timeout, in seconds. Note that the SPS web UI displays the same value in seconds. |
| cipher_strength |
|
JSON object |
Specifies the cipher string OpenSSL will use. |
|
custom_cipher |
string |
The list of ciphers you want to permit SPS to use in the connection. For more details on customizing this list, check the 'openssl-ciphers' manual page on your SPS appliance. |
|
selection |
string |
Specifies the cipher string OpenSSL will use. The following settings options are possible:
-
recommended: this setting only uses ciphers with adequate security level.
-
custom: this setting allows you to specify the list of ciphers you want to permit SPS to use in the connection. This setting is only recommended to ensure compatibility with older systems. For more details on customizing this list, check the 'openssl-ciphers' manual page on your SPS appliance.
For example: ALL:!aNULL:@STRENGTH |
| minimum_tls_version |
|
string |
Specifies the minimal TLS version SPS will offer during negotiation. The following settings options are possible:
-
TLSv1_2: this setting only offers TLS version 1.2 during the negotiation. This is the recommended setting.
-
TLSv1_1: this setting offers TLS version 1.1 and later versions during the negotiation.
-
TLSv1_0: this setting offers TLS version 1.0 and later versions during the negotiation. |
Add MSSQL settings policies
To add a settings policy, you have to:
-
Open a transaction.
For more information, see Open a transaction.
-
Create the JSON object for the new policy.
POST the JSON object to the https://<IP-address-of-SPS>/api/configuration/mssql/settings_policies/ endpoint. You can find a detailed description of the available parameters listed in Element .
If the POST request is successful, the response includes the key of the new policy. For example:
{
"key": "3848c708-2e1d-4463-b232-0c8c5875ff55",
"meta": {
"href": "/api/configuration/mssql/settings_policies/3848c708-2e1d-4463-b232-0c8c5875ff55",
"parent": "/api/configuration/mssql/settings_policies",
"transaction": "/api/transaction"
}
}
-
Commit your changes.
For more information, see Commit a transaction.
Modify MSSQL settings policies
To modify a settings policy, you have to:
-
Open a transaction.
For more information, see Open a transaction.
-
Modify the JSON object of the policy.
PUT the modified JSON object to the https://<IP-address-of-SPS>/api/configuration/mssql/settings_policies/<key-of-the-object> endpoint. You can find a detailed description of the available parameters listed in Element .
-
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. |
List of endpoints for configuring the policies, options and connection rules of RDP connections.
URL
GET https://<IP-address-of-SPS>/api/configuration/rdp
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 RDP connections.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/rdp
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/rdp/channel_policies"
}
},
{
"key": "connections",
"meta": {
"href": "/api/configuration/rdp/connections"
}
},
{
"key": "domain_membership",
"meta": {
"href": "/api/configuration/rdp/domain_membership"
}
},
{
"key": "options",
"meta": {
"href": "/api/configuration/rdp/options"
}
},
{
"key": "settings_policies",
"meta": {
"href": "/api/configuration/rdp/settings_policies"
}
}
],
"meta": {
"first": "/api/configuration/aaa",
"href": "/api/configuration/rdp",
"last": "/api/configuration/x509",
"next": "/api/configuration/reporting",
"parent": "/api/configuration",
"previous": "/api/configuration/private_keys",
"transaction": "/api/transaction"
}
}
| channel_policies |
List of the default and custom channel policies. |
| connections |
List of connection policies. |
| domain_membership |
Domain membership configuration. Prerequisite for configuring Credential Security Service Provider / Network Layer Authentication. |
| options |
List of global RDP options that affect all connections. |
| settings_policies |
List of protocol-level settings (timeout, display, protocol version, and authentication). You can create multiple variations, and choose the appropriate one for each connection policy. |
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. |
