Acquire an activation key

This is an API function to acquire an Activation key for Agent. 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 GET --header 'Accept: application/json'
            --header 'X-API-KEY:APIKEY'
            'http://HOSTNAME:PORTNUMBER/api/v1/activation-key'
Request parameter

A request parameter is not required.

Response
{
  "activationKey": "string",
  "numberOfActiveAgents": 0,
  "numberOfAgents": 0,
  "registrationDate": 0,
  "whitelistEnabled": true
}
Response parameter
Item name Response parameter Type Value
Activation Key activationKey String  
Number of Agents in Use numberOfActiveAgents Integer The number of Agent instances that are used is returned.
Maximum Number of Agents That Can be Used numberOfAgents Integer

•　0: unlimited

•　1 or more: the maximum number of Agent instances that can be used.
Registration Date and Time registrationDate Integer

The value is returned by using a "yyyyMMddHHmmssSSS" format.

Example: 20171124164131676
Whitelist Activation whitelistEnabled Boolean

•　true: Whitelist is enabled.

•　false: Whitelist is disabled.