HTTP settings policies define protocol-level settings for idle and session timeout. You can create multiple policies, and choose the appropriate one for each HTTP connection.
URL
GET https://<IP-address-of-SPS>/api/configuration/http/settings_policies
Cookies
| Cookie name | Description | Required | Values |
|---|---|---|---|
| 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 that 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 HTTP settings policies.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/http/settings_policies
The following command retrieves the properties of a specific policy.
curl --cookie cookies https://<IP-address-of-SPS>/api/configuration/http/settings_policies/<policy-id>
Response
The following is a sample response received when listing HTTP settings policies.
For details of the meta object, see Message format.
{
"items": [
{
"key": "-3040010",
"meta": {
"href": "/api/configuration/http/settings_policies/-3040010"
}
}
],
"meta": {
"first": "/api/configuration/http/channel_policies",
"href": "/api/configuration/http/settings_policies",
"last": "/api/configuration/http/settings_policies",
"next": null,
"parent": "/api/configuration/http",
"previous": "/api/configuration/http/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
"webapp_session_cookies": [
"PHPSESSID",
"JSESSIONID",
"ASP.NET_SessionId"
]
},
"key": "-3040010",
"meta": {
"first": "/api/configuration/http/settings_policies/-3040010",
"href": "/api/configuration/http/settings_policies/-3040010",
"last": "/api/configuration/http/settings_policies/-3040010",
"next": null,
"parent": "/api/configuration/http/settings_policies",
"previous": null,
"transaction": "/api/transaction"
}
}
| Element | Type | Description | |
|---|---|---|---|
| key | string | Top level element, contains the ID of the policy. | |
| body | Top level element (string) | The elements of the HTTP settings policy. | |
| client_tls_security_settings | JSON object | Configures TLS security settings on the client side. | |
| name | string | Name of the HTTP settings policy. Cannot contain whitespace. | |
| server_tls_security_settings | JSON object | Configures TLS security settings on the server side. | |
| session_timeout | int | Session timeout, in seconds. | |
| timeout | int | Idle timeout, in seconds. Note that the SPS web UI displays the same value in seconds. | |
| webapp_session_cookies | list (string) |
To distinguish the audited HTTP requests and responses based on the session cookies of web applications, enter the name of the session cookie, for example, PHPSESSID, JSESSIONID, or ASP.NET_SessionId. Note that the names of session cookies are case sensitive. Note that this is a priority list. If there are multiple cookie names, SPS will use the first one from this list it finds in the request headers to assign the requests to a session. | |
Add HTTP 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/http/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/http/settings_policies/3848c708-2e1d-4463-b232-0c8c5875ff55", "parent": "/api/configuration/http/settings_policies", "transaction": "/api/transaction" } } -
Commit your changes.
For more information, see Commit a transaction.
Modify HTTP 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/http/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.
| Code | Description | Notes |
|---|---|---|
| 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. |
