- URL:https://<system-url>/properties/update(POST only)
- Required Capability:Administrator
- Version Introduced:10.8
Description
This operation allows you to update the server properties.
Note:
The update operation overwrites all existing properties.Request parameters
Parameter | Details |
---|---|
properties | The JSON object containing the server properties. |
f | The response format. The default response format is html. Values: html | json| pjson |
Example usage
This operation returns information for AuthTokenTimeInSeconds, WebContextURL and WebSocketContextURL. For more information on these operations, see Server Properties.
Below is a sample POST request for update, formatted for readability:
POST /webadaptor/admin/system/properties/update HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
properties={
"AuthTokenTimeInSeconds": 180,
"WebContextURL": "https://mycompany.com/mission",
"WebSocketContextURL": "wss://mycompany.com/mission"
}&f=json
JSON Response example
{"status": "success"}