Enable and disable activation whitelist function

This is an API function to change the whitelist function enable or disable. This API function corresponds to the operation on the screen that is displayed by clicking the [Agent] tab after selecting the [License] on the operation screen of Manager.

= Remarks =

The response parameters of the following API functions are the same.

  • Acquire an activation key
  • Enable and disable activation whitelist function
Format
curl -X PUT --header 'Content-Type: application/json'
            --header 'Accept: application/json'
            --header 'X-API-KEY:APIKEY'
            -d 'REQUESTBODYINJSONFORMAT'
            'http://HOSTNAME:PORTNUMBER/api/v1/activation-key'
Request body (JSON format)
{
  "whitelistEnabled": true
}
Request parameter (JSON format)
Item name Request parameter Type Value Default value
Activation whitelist whitelistEnabled Boolean

Specify to switch the whitelist function on or off.

•　true: enable

•　false: disable

 Impossible to omit
Response
{
  "activationKey": "string",
  "numberOfActiveAgents": 0,
  "numberOfAgents": 0,
  "registrationDate": 0,
  "whitelistEnabled": true
}
Response parameter

For details of the response parameters, see Response parameter　described in Acquire an activation key.