Configuration of advanced server settings

Edit online

9.2.3 Available from 9.2.3.

You use the PUT operation on the api/sam/configs element to change the values of the License Metric Tool server settings.

Permissions

An icon representing a user. You must be an Administrator to perform this task.

Resource URL

https://hostname:port/api/sam/configs

Resource information

Table 1. Resource information
Operation details Description
Purpose Changes the current value of a server setting.
HTTP method PUT
Resource URI https://hostname:port/api/sam/configs
URL query parameters For a list of query parameters, see: Query parameters.
Request headers
Accept-Language (optional)
  • Use: Used to negotiate the language of the response. If this header is not specified, the content is returned in the server language.
  • Values: en-US (only English is supported)
Token
  • Use: Used to authenticate REST API requests. The header is required when you set the value of the api_token_in_url_enabled parameter to false. Otherwise, you can specify the token in the request header or in the URL. For more information, see: Authenticating REST API requests.
  • Values: an alphanumeric string that is generated in License Metric Tool
Request payload n/a
Request Content-Type
  • application/x-www-form-urlencoded
Response headers
Content-Type
  • Use: Specifies the content type of the response.
  • Values: application/json
Content-Language
  • Use: Specifies the language of the response content. If this header is not specified, the content is returned in the server language.
  • Values: en-US, …
Response payload n/a
Response Content-Type n/a
Normal HTTP response codes
  • 204
Error HTTP response codes
  • 400 - Bad Request if the provided value is invalid. For example, it is out of range or has a wrong type.
  • 404 - Not Found

Query parameters

The following table presents query parameters that you can use for the configs element.

Table 2. Query parameters for changing current values of server settings
Parameter Description Required Value
name Specifies the parameter whose value is to be changed. For a complete list of possible values and their explanation, see: Advanced server settings. Yes Name of the parameter
value Specifies the new value of the parameter. Yes Value that is within the range specific for the parameter.

Example HTTP conversation

Request
PUT https://hostname:port/api/sam/configs
?name=maxVMManagerInactivity&value=30
Request header
Accept: application/json
Accept-Language: en-US
Token: <token>