Virima API Specification - AgentResourceMonitor Services

The requests documented in this section are directed to AgentResourceMonitor resources, which represent User Add,Update,Delete Agent resource monitor-- as called by a partner or directly by a webapp using the API..

Contents

1 addAgentMonitorScript POST Interface
2 editAgentMonitorScript POST Interface
3 getActiveScriptsAndIncidents POST Interface

addAgentMonitorScript POST Interface

add-monitoring-script(POST) is called when user is trying to add-monitoring-script.

It add-monitoring-script as per the post request

Method: POST

Relative URL: agent-resource-monitor/add-monitoring-script

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
agentResourceMonitor	AgentResourceMonitor

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

ADDAGENTMONITORSCRIPT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "name":"?",
   "description":"?",
   "script":"?",
   "scriptCategory":"?",
   "hostType":"?",
   "action":"?",
   "archive":?,
   "parameters":"?",
   "agentList":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "agentListWithActiveStatus":"?",
   "scriptsList":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "agentId":?,
   "dataPeriod":"?",
   "outOf":?,
   "dataPoints":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

editAgentMonitorScript POST Interface

edit-monitoring-script(POST) is called when user is trying to edit Script.

It edit-monitoring-script as per the post request

Method: POST

Relative URL: agent-resource-monitor/edit-monitoring-script

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
agentResourceMonitor	AgentResourceMonitor

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

EDITAGENTMONITORSCRIPT 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "name":"?",
   "description":"?",
   "script":"?",
   "scriptCategory":"?",
   "hostType":"?",
   "action":"?",
   "archive":?,
   "parameters":"?",
   "agentList":[
      {
         "id":1877918777,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "agentListWithActiveStatus":"?",
   "scriptsList":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "agentId":?,
   "dataPeriod":"?",
   "outOf":?,
   "dataPoints":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}

getActiveScriptsAndIncidents POST Interface

get-active-scriptAndIncidents-from-agent(POST) is called when user is trying Get All Scripts Details WIth Respect To Agents.

It get-active-scriptAndIncidents-from-agent as per the post request

Method: POST

Relative URL: agent-resource-monitor/get-active-scriptandincidents-from-agent

Request Headers: Accept, Authorization

Response Headers: Content-Length, Content-Type.

Request Structure:

Field Name	Type	Description
agentResourceMonitor	AgentResourceMonitor

Response Structure:

Field Name	Type	Description
response	Response

Example Request:

GETACTIVESCRIPTSANDINCIDENTS 
Host: example.com
Authorization: Basic xxxxxxxxxxxxxxxxxxx
Content-Type : nnn
{
   "id":2147483647,
   "name":"?",
   "description":"?",
   "script":"?",
   "scriptCategory":"?",
   "hostType":"?",
   "action":"?",
   "archive":?,
   "parameters":"?",
   "agentList":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "agentListWithActiveStatus":"?",
   "scriptsList":[
      {
         "id":2147483647,
         "stringobj":"?",
         "shortName":"?",
         "s3Name":"?",
         "uniqueId":"?",
         "lineType":"?",
      }   ],
   "agentId":?,
   "dataPeriod":"?",
   "outOf":?,
   "dataPoints":?
}

Example Response:

{
   "id":2147483647,
   "response":"?"
}