Retrieval of the current values of advanced server settings

Available from 9.2.3. You use the GET operation on the api/sam/configs element to request information about the current values of the BigFix Inventory server settings. The output is returned in the JSON format.

Table 1. Operation descriptions

The table consists of 2 columns and 15 rows.

Operation details Description
Operation GET /api/sam/configs
Purpose Returns information about the current values of the BigFix Inventory server settings.
HTTP method GET
Resource URI https://server_host_name:port_number/api/sam/configs
URL link relation n/a
URL query parameters For a list of query parameters, see: Query parameters.
Request headers
Header
Accept-Language (optional)
Values
en-US (only English is supported)

Used to negotiate the language of the response. If this header is not specified, the content is returned in the server language.
Request payload n/a
Request Content-Type
  • Application/json
Response headers
Header
Content-Type
Values
Application/json

Specifies the content type of the response.
Header
Content-Language
Values
en-US, …

Specifies the language of the response content. If this header is not specified, the content is returned in the server language.
Response payload configs element
Response Content-Type
  • Application/json
Normal HTTP response codes n/a
Error HTTP response codes n/a

Query parameters

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

Table 2. Query parameters for retrieving current values of server settings

The table consists of four columns and two rows.
Parameter Description Required Value
name Returns the configuration of a single parameter. For a complete list of possible values and their explanation, see: Advanced server settings. No Name of the parameter
token A unique user authentication identifier. Yes Alphanumeric

Example HTTP conversation

Checking the current value of all parameters.
Request
GET https://localhost:9081/api/sam/configs?token=
7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Excerpt for the response body (JSON) 
[
{"valueMax":10080,
"valueMin":0,
"valueType":"minutes",
"name":"vmman_transfer_period","value":"720"},

{"valueType":"boolean",
"name":"vmman_check_uniqueness_enabled",
"value":"true"},

{"valueType":"boolean",
"name":"blockUiBundlingComputations",
"value":"false"},

{"valueMax":10080,
"valueMin":0,
"valueType":"minutes",
"name":"catalog_download_task_stagger_interval",
"value":"0"},

{"valueType":"boolean",
"name":"storeHwDataForAllVMManagerNodes",
"value":"false"},
]
Checking the current value of a single parameter.
Request
GET https://localhost:9081/api/sam/configs?token=
7adc3efb175e2bc0f4484bdd2efca54a8fa04623&name=maxVMManagerInactivity
Response body (JSON)
[
{"valueMax":90,
"valueMin":1,
"valueType":"days",
"name":"maxVMManagerInactivity",
"value":"3"}
]