Change status of an Agent instance

This is an API function to change status of an Agent instance. This API function corresponds to the operation when you select the [Start Usage] or the [Standby] by using the [Action] button that is displayed by selecting the [Agent] on the operation screen of Manager.

= Remarks =

The following set of API functions is actually the same. (/api/v1/agents/agentId)

  • Change status of an Agent instance
  • Change operation settings for an Agent instance
  • Change unit
  • Change profile
  • Change a module version

In this manual, to write each API function separately for individual purposes, the request parameters are changed according to the purposes.
Format
curl -X PUT --header 'Content-Type: application/json'
            --header 'X-API-KEY:APIKEY'
            -d 'REQUESTBODYINJSONFORMAT'
            'http://HOSTNAME:PORTNUMBER/api/v1/agents/agentId'
Request body (JSON format)
{
   "status": "ON"
}
Request parameter (JSON format)
Item name Request parameter Type Value Default value
Agent status status String

"ON"　|　"OFF"

•　ON: Agent is in use.

•　OFF: Agent is on standby.

 Impossible to omit
Request parameter (Path format)
Item name Request parameter Type Value Default value
Agent ID agentId String   Impossible to omit